Avi BackupConfiguration Object API
CLI ``` - show backupconfiguration - configure backupconfiguration ```
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /backupconfigurationpost /backupconfigurationdelete /backupconfiguration/{uuid}get /backupconfiguration/{uuid}patch /backupconfiguration/{uuid}put /backupconfiguration/{uuid}
Up
get /backupconfiguration
(backupconfigurationGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"backup_passphrase" : "aeiou",
"save_local" : true,
"remote_directory" : "aeiou",
"remote_hostname" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"aws_secret_access" : "aeiou",
"backup_file_prefix" : "aeiou",
"ssh_user_ref" : "aeiou",
"aws_access_key" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"aws_bucket_id" : "aeiou",
"upload_to_s3" : true,
"upload_to_remote_host" : true,
"maximum_backups_stored" : 123
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BackupConfigurationApiResponse
401
log in failed
Up
post /backupconfiguration
(backupconfigurationPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BackupConfiguration object creation
Return type
Example data
Content-Type: application/json
{
"backup_passphrase" : "aeiou",
"save_local" : true,
"remote_directory" : "aeiou",
"remote_hostname" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"aws_secret_access" : "aeiou",
"backup_file_prefix" : "aeiou",
"ssh_user_ref" : "aeiou",
"aws_access_key" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"aws_bucket_id" : "aeiou",
"upload_to_s3" : true,
"upload_to_remote_host" : true,
"maximum_backups_stored" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BackupConfiguration
401
log in failed
Up
delete /backupconfiguration/{uuid}
(backupconfigurationUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /backupconfiguration/{uuid}
(backupconfigurationUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"backup_passphrase" : "aeiou",
"save_local" : true,
"remote_directory" : "aeiou",
"remote_hostname" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"aws_secret_access" : "aeiou",
"backup_file_prefix" : "aeiou",
"ssh_user_ref" : "aeiou",
"aws_access_key" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"aws_bucket_id" : "aeiou",
"upload_to_s3" : true,
"upload_to_remote_host" : true,
"maximum_backups_stored" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BackupConfiguration
401
log in failed
Up
patch /backupconfiguration/{uuid}
(backupconfigurationUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BackupConfiguration object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"backup_passphrase" : "aeiou",
"save_local" : true,
"remote_directory" : "aeiou",
"remote_hostname" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"aws_secret_access" : "aeiou",
"backup_file_prefix" : "aeiou",
"ssh_user_ref" : "aeiou",
"aws_access_key" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"aws_bucket_id" : "aeiou",
"upload_to_s3" : true,
"upload_to_remote_host" : true,
"maximum_backups_stored" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BackupConfiguration
401
log in failed
Up
put /backupconfiguration/{uuid}
(backupconfigurationUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BackupConfiguration object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"backup_passphrase" : "aeiou",
"save_local" : true,
"remote_directory" : "aeiou",
"remote_hostname" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"aws_secret_access" : "aeiou",
"backup_file_prefix" : "aeiou",
"ssh_user_ref" : "aeiou",
"aws_access_key" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"aws_bucket_id" : "aeiou",
"upload_to_s3" : true,
"upload_to_remote_host" : true,
"maximum_backups_stored" : 123
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BackupConfiguration
401
log in failed
[ Jump to Methods ]
Table of Contents
BackupConfigurationBackupConfigurationApiResponse
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
aws_access_key (optional)
String AWS Access Key ID. Field introduced in 18.2.3.
aws_bucket_id (optional)
String AWS bucket. Field introduced in 18.2.3.
aws_secret_access (optional)
String AWS Secret Access Key. Field introduced in 18.2.3.
backup_file_prefix (optional)
String Prefix of the exported configuration file. Field introduced in 17.1.1.
backup_passphrase (optional)
String Default passphrase for configuration export and periodic backup.
maximum_backups_stored (optional)
Integer Rotate the backup files based on this count. Allowed values are 1-20. format: int32
name
String Name of backup configuration.
remote_directory (optional)
String Directory at remote destination with write permission for ssh user.
remote_hostname (optional)
save_local (optional)
ssh_user_ref (optional)
String Access Credentials for remote destination. It is a reference to an object of type CloudConnectorUser.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
upload_to_remote_host (optional)
upload_to_s3 (optional)
Boolean Cloud Backup. Field introduced in 18.2.3.
url (optional)
uuid (optional)
String Unique object identifier of the object.
count
results
next (optional)