Avi BackupConfiguration Object API
CLI ``` - show backupconfiguration - configure backupconfiguration ```
Version: 22.1.5
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" : [ {
"aws_bucket_region" : "aeiou",
"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",
"configpb_attributes" : {
"version" : 123
},
"remote_file_transfer_protocol" : "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
{
"aws_bucket_region" : "aeiou",
"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",
"configpb_attributes" : {
"version" : 123
},
"remote_file_transfer_protocol" : "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
{
"aws_bucket_region" : "aeiou",
"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",
"configpb_attributes" : {
"version" : 123
},
"remote_file_transfer_protocol" : "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
{
"aws_bucket_region" : "aeiou",
"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",
"configpb_attributes" : {
"version" : 123
},
"remote_file_transfer_protocol" : "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
{
"aws_bucket_region" : "aeiou",
"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",
"configpb_attributes" : {
"version" : 123
},
"remote_file_transfer_protocol" : "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
BackupConfigurationBackupConfigurationApiResponseConfigPbAttributes
_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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
aws_bucket_id (optional)
String AWS bucket. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
aws_bucket_region (optional)
String 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 (optional)
String AWS Secret Access Key. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
backup_file_prefix (optional)
String 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.
backup_passphrase (optional)
String Default passphrase for configuration export and periodic backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
maximum_backups_stored (optional)
Integer 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. format: int32
name
String Name of backup configuration. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
remote_directory (optional)
String 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 (optional)
String 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_hostname (optional)
String Remote Destination. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
save_local (optional)
Boolean Local Backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssh_user_ref (optional)
String 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.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
upload_to_remote_host (optional)
Boolean Remote Backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
upload_to_s3 (optional)
Boolean Cloud Backup. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32