PATCH /backupconfiguration/{uuid}

PATCH /backupconfiguration/{uuid}

/backupconfiguration/{uuid}

Request
URI
PATCH
https://{api_host}/api/backupconfiguration/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

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.

string
X-CSRFToken
Optional

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.

Request Body

BackupConfiguration object creation

BackupConfiguration of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_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"
}
Responses
200

OK

Returns BackupConfiguration of type(s) application/json 
"BackupConfiguration Object"
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 in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
aws_bucket_id
Optional

AWS bucket. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, 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 in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
aws_secret_access
Optional

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

string
backup_file_prefix
Optional

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.

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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

string
remote_directory
Optional

Directory at remote destination with write permission for ssh user. Allowed in Enterprise edition with any value, 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 in Enterprise edition with any value, Basic edition(Allowed values- SCP,SFTP), Enterprise with Cloud Services edition.

string
remote_hostname
Optional

Remote Destination. Allowed in Enterprise edition with any value, 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 in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
save_local
Optional

Local Backup. Allowed in Enterprise edition with any value, 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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

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

boolean
upload_to_remote_host
Optional

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

boolean
upload_to_s3
Optional

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

string
url
Optional

url

string
uuid
Optional

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


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'
On This Page
Backup Configuration Operations
GET
GET /backupconfiguration
POST
POST /backupconfiguration
GET
GET /backupconfiguration/{uuid}
PUT
PUT /backupconfiguration/{uuid}
PATCH
PATCH /backupconfiguration/{uuid}
DELETE
DELETE /backupconfiguration/{uuid}