PATCH /backup/{uuid}

PATCH /backup/{uuid}

/backup/{uuid}

Request
URI
PATCH
https://{api_host}/api/backup/{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

Backup object creation

Backup of type(s) application/json
Optional

Show optional properties

{
    "file_name": "string"
}
{
    "_last_modified": "string",
    "backup_config_ref": "string",
    "file_name": "string",
    "local_file_url": "string",
    "remote_file_url": "string",
    "scheduler_ref": "string",
    "tenant_ref": "string",
    "timestamp": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns Backup of type(s) application/json 
"Backup Object"
string
_last_modified
Optional

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

string
backup_config_ref
Optional

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

string
file_name
Required

The file name of backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
local_file_url
Optional

URL to download the backup file. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
remote_file_url
Optional

URL to download the backup file. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
scheduler_ref
Optional

Scheduler Information. It is a reference to an object of type Scheduler. 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.

string
timestamp
Optional

Unix Timestamp of when the backup file is created. Allowed in Enterprise edition with any value, Essentials, Basic, 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 '{"file_name:"string"}'
On This Page
Backup Operations
GET
GET /backup
POST
POST /backup
GET
GET /backup/{uuid}
PUT
PUT /backup/{uuid}
PATCH
PATCH /backup/{uuid}
DELETE
DELETE /backup/{uuid}