cloudsync.create

Creates a new cloud_sync entry.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: cloud_sync_create

cloud_sync_create

Type: object
No Additional Properties

Description

Type: string Default: ""

The name of the task to display in the UI

Path

Type: string

The local path to back up beginning with /mnt or /dev/zvol

Credentials

Type: integer

ID of the cloud credential

Attributes

Type: object

Additional information for each backup, e.g. bucket name

CloudCron

Type: object

Cron schedule dictating when the task should run

 No Additional Properties

Minute

Type: string Default: "00"

Hour

Type: string Default: "*"

"00" - "23"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

"1" (January) - "12" (December)

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

Pre Script

Type: string Default: ""

A Bash script to run immediately before every backup

Post Script

Type: string Default: ""

A Bash script to run immediately after every backup if it succeeds

Snapshot

Type: boolean Default: false

Whether to create a temporary snapshot of the dataset before every backup

Include

Type: array of string

Paths to pass to restic backup --include

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Exclude

Type: array of string

Paths to pass to restic backup --exclude

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Args

Type: string Default: ""

(Slated for removal)

Enabled

Type: boolean Default: true

Can enable/disable the task

Bwlimit

Type: array of object
No Additional Items
Each item of this array must be:

CloudSyncBwlimit

Type: object
No Additional Properties

Time

Type: string

Bandwidth


Type: integer

Value must be strictly greater than 0

Type: null

Transfers

Default: null

Type: integer

Value must be strictly greater than 0

Type: null

Direction

Type: enum (of string)
Must be one of:
  • "PUSH"
  • "PULL"

Transfer Mode

Type: enum (of string)
Must be one of:
  • "SYNC"
  • "COPY"
  • "MOVE"

Encryption

Type: boolean Default: false

Filename Encryption

Type: boolean Default: false

Encryption Password

Type: string Default: ""

Encryption Salt

Type: string Default: ""

Create Empty Src Dirs

Type: boolean Default: false

CloudSyncEntry

Type: object
No Additional Properties

Id

Type: integer

Description

Type: string Default: ""

The name of the task to display in the UI

Path

Type: string

The local path to back up beginning with /mnt or /dev/zvol

CloudCredentialEntry

Type: object

Cloud credentials to use for each backup

 No Additional Properties

Id

Type: integer

Name

Type: string

Must be at least 1 characters long

Provider


AzureBlobCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "AZUREBLOB"
Specific value: "AZUREBLOB"

Account

Type: string

Must be at least 1 characters long

Key

Type: string

Must be at least 1 characters long

Endpoint

Default: ""

Type: const
Must be one of:
  • ""
Specific value: ""
Type: stringFormat: uri

Must be at least 1 characters long

Must be at most 2083 characters long

B2CredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "B2"
Specific value: "B2"

Account

Type: string

Must be at least 1 characters long

Key

Type: string

Must be at least 1 characters long

BoxCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "BOX"
Specific value: "BOX"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

DropboxCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "DROPBOX"
Specific value: "DROPBOX"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

FTPCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "FTP"
Specific value: "FTP"

Host

Type: string

Must be at least 1 characters long

Port

Type: integer Default: 21

User

Type: string

Must be at least 1 characters long

Pass

Type: string

GoogleCloudStorageCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "GOOGLE_CLOUD_STORAGE"
Specific value: "GOOGLE_CLOUD_STORAGE"

Service Account Credentials

Type: string

Must be at least 1 characters long

GoogleDriveCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "GOOGLE_DRIVE"
Specific value: "GOOGLE_DRIVE"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

Team Drive

Type: string Default: ""

GooglePhotosCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "GOOGLE_PHOTOS"
Specific value: "GOOGLE_PHOTOS"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

HTTPCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "HTTP"
Specific value: "HTTP"

Url

Type: stringFormat: uri

Must be at least 1 characters long

Must be at most 2083 characters long

HubicCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "HUBIC"
Specific value: "HUBIC"

Token

Type: string

Must be at least 1 characters long

MegaCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "MEGA"
Specific value: "MEGA"

User

Type: string

Must be at least 1 characters long

Pass

Type: string

Must be at least 1 characters long

OneDriveCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "ONEDRIVE"
Specific value: "ONEDRIVE"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

Drive Type

Type: enum (of string)
Must be one of:
  • "PERSONAL"
  • "BUSINESS"
  • "DOCUMENT_LIBRARY"

Drive Id

Type: string

PCloudCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "PCLOUD"
Specific value: "PCLOUD"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

Hostname

Type: string Default: ""

S3CredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "S3"
Specific value: "S3"

Access Key Id

Type: string

Must be at least 1 characters long

Secret Access Key

Type: string

Must be at least 1 characters long

Endpoint

Type: string Default: ""

Region

Type: string Default: ""

Skip Region

Type: boolean Default: false

Signatures V2

Type: boolean Default: false

Max Upload Parts

Type: integer Default: 10000

SFTPCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "SFTP"
Specific value: "SFTP"

Host

Type: string

Must be at least 1 characters long

Port

Type: integer Default: 22

User

Type: string

Must be at least 1 characters long

Pass

Default: null

Type: string
Type: null

Private Key

Default: null

Type: integer
Type: null

StorjIxCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "STORJ_IX"
Specific value: "STORJ_IX"

Access Key Id

Type: string

Must be at least 1 characters long

Secret Access Key

Type: string

Must be at least 1 characters long

Endpoint

Type: stringFormat: uri Default: "https://gateway.storjshare.io/"

Must be at least 1 characters long

Must be at most 2083 characters long

SwiftCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "OPENSTACK_SWIFT"
Specific value: "OPENSTACK_SWIFT"

User

Type: string

Must be at least 1 characters long

Key

Type: string

Must be at least 1 characters long

Auth

Type: string

Must be at least 1 characters long

User Id

Type: string Default: ""

Domain

Type: string Default: ""

Tenant

Type: string Default: ""

Tenant Id

Type: string Default: ""

Tenant Domain

Type: string Default: ""

Region

Type: string Default: ""

Storage Url

Type: string Default: ""

Auth Token

Type: string Default: ""

Application Credential Id

Type: string Default: ""

Application Credential Name

Type: string Default: ""

Application Credential Secret

Type: string Default: ""

Auth Version


Type: enum (of integer)
Must be one of:
  • 0
  • 1
  • 2
  • 3
Type: null

Endpoint Type


Type: enum (of string)
Must be one of:
  • "public"
  • "internal"
  • "admin"
Type: null

WebDavCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "WEBDAV"
Specific value: "WEBDAV"

Url

Type: stringFormat: uri

Must be at least 1 characters long

Must be at most 2083 characters long

Vendor

Type: enum (of string)
Must be one of:
  • "NEXTCLOUD"
  • "OWNCLOUD"
  • "SHAREPOINT"
  • "OTHER"

User

Type: string

Pass

Type: string

YandexCredentialsModel

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "YANDEX"
Specific value: "YANDEX"

Client Id

Type: string Default: ""

Client Secret

Type: string Default: ""

Token

Type: string

Must be at least 1 characters long

Attributes

Type: object

Additional information for each backup, e.g. bucket name

CloudCron

Type: object

Cron schedule dictating when the task should run

 No Additional Properties

Minute

Type: string Default: "00"

Hour

Type: string Default: "*"

"00" - "23"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

"1" (January) - "12" (December)

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

Pre Script

Type: string Default: ""

A Bash script to run immediately before every backup

Post Script

Type: string Default: ""

A Bash script to run immediately after every backup if it succeeds

Snapshot

Type: boolean Default: false

Whether to create a temporary snapshot of the dataset before every backup

Include

Type: array of string

Paths to pass to restic backup --include

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Exclude

Type: array of string

Paths to pass to restic backup --exclude

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Args

Type: string Default: ""

(Slated for removal)

Enabled

Type: boolean Default: true

Can enable/disable the task

Job


Information regarding the task's job state, e.g. progress

Type: object
Type: null

Locked

Type: boolean

A locked task cannot run

Bwlimit

Type: array of object
No Additional Items
Each item of this array must be:

CloudSyncBwlimit

Type: object
No Additional Properties

Time

Type: string

Bandwidth


Type: integer

Value must be strictly greater than 0

Type: null

Transfers

Default: null

Type: integer

Value must be strictly greater than 0

Type: null

Direction

Type: enum (of string)
Must be one of:
  • "PUSH"
  • "PULL"

Transfer Mode

Type: enum (of string)
Must be one of:
  • "SYNC"
  • "COPY"
  • "MOVE"

Encryption

Type: boolean Default: false

Filename Encryption

Type: boolean Default: false

Encryption Password

Type: string Default: ""

Encryption Salt

Type: string Default: ""

Create Empty Src Dirs

Type: boolean Default: false


Required roles: CLOUD_SYNC_WRITE