BackupConfiguration

JSON Example

{
    "_last_modified": "string",
    "aws_access_key": "string",
    "aws_bucket_id": "string",
    "aws_bucket_region": "string",
    "aws_secret_access": "string",
    "backup_file_prefix": "string",
    "backup_passphrase": "string",
    "bundle_mode": false,
    "configpb_attributes": {
        "version": 0
    },
    "maximum_backups_stored": 0,
    "name": "string",
    "remote_directory": "string",
    "remote_file_transfer_protocol": "string",
    "remote_hostname": "string",
    "s3_bucket_folder": "string",
    "save_local": false,
    "ssh_user_ref": "string",
    "tenant_ref": "string",
    "upload_to_remote_host": false,
    "upload_to_s3": false,
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string

aws_access_key

Optional

AWS Access Key ID. Field introduced in 18.2.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string

aws_bucket_id

Optional

AWS bucket. Field introduced in 18.2.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string

aws_bucket_region

Optional

The name of the AWS region associated with the bucket. Field introduced in 21.1.5, 22.1.1, 22.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string

aws_secret_access

Optional

AWS Secret Access Key. Field introduced in 18.2.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string

backup_file_prefix

Optional

Prefix of the exported configuration file. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

backup_passphrase

Optional

Default passphrase to encrypt sensitive fields for configuration export and periodic backup. The same passphrase must be provided to import the configuration. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

bundle_mode

Optional

By default, JSON Backups are generated. When this flag is enabled, bundle backups will be generated. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

integer As uint32 As uint32

maximum_backups_stored

Optional

Constraints: default: 4

Rotate the backup files based on this count. Allowed values are 1-20. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Required

Name of backup configuration. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

remote_directory

Optional

Directory at remote destination with write permission for ssh user. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

remote_file_transfer_protocol

Optional

Constraints: default: SCP

Remote file transfer protocol type. Enum options - SCP, SFTP. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Basic (Allowed values- SCP,SFTP) edition.

string

remote_hostname

Optional

Remote Destination. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

s3_bucket_folder

Optional

The folder name in s3 bucket where backup will be stored. Field introduced in 30.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean

save_local

Optional

Local Backup. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

ssh_user_ref

Optional

Access Credentials for remote destination. It is a reference to an object of type CloudConnectorUser. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

It is a reference to an object of type Tenant. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

upload_to_remote_host

Optional

Remote Backup. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

upload_to_s3

Optional

Cloud Backup. Field introduced in 18.2.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.