GET /backupconfiguration/{uuid}
/backupconfiguration/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
OK
{
"_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",
"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"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
AWS Access Key ID. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
AWS bucket. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
The name of the AWS region associated with the bucket. Field introduced in 21.1.5, 22.1.1, 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
AWS Secret Access Key. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Prefix of the exported configuration file. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Default passphrase to encrypt sensitive fields for configuration export and periodic backup. The same passphrase must be provided to import the configuration. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes
Rotate the backup files based on this count. Allowed values are 1-20. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Name of backup configuration. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Directory at remote destination with write permission for ssh user. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Remote file transfer protocol type. Enum options - SCP, SFTP. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Basic edition(Allowed values- SCP,SFTP), Enterprise with Cloud Services edition.
Remote Destination. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
The folder name in s3 bucket where backup will be stored. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Local Backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Access Credentials for remote destination. It is a reference to an object of type CloudConnectorUser. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Remote Backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Cloud Backup. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/backupconfiguration/{uuid}