Skip to main content
POST
cURL

Body

application/json
cloud_type
enum<integer>
required

Cloud type.

Available options:
1,
4,
8,
16,
32,
256,
1024,
2048
CID
string

The opaque session ID token. Required for 7.2 controllers only.

acct_name
string

The account name for the backup.

action
string

The API action to perform. Required for 7.2 controllers only.

bkup_cron
string

Cron expression of backup.

bucket_name
string

AWS/OCI bucket name associated with the acct_name to save the controller configuration.

bucket_name2
string

AWS 2nd bucket name with the acct_name to save the controller configuration.

container_name
string

Azure container name associated with the acct_name to save the controller configuration.

container_name2
string

Azure container name 2 associated with the acct_name to save the controller configuration.

multiple
boolean

Enable multiple backups.

multiple_bkup_len
integer

Max length of multiple backups.

now
boolean

Backup only.

region
string

OCI/Azure storage region.

region2
string

Azure storage region2.

storage_name
string

Azure storage name associated with the acct_name to save the controller configuration.

storage_name2
string

Azure storage name 2 associated with the acct_name to save the controller configuration.

use_node_role
boolean

Use Identity Role associated with the node to do the backup to cloud storage.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype
string

Error type if the API failed.

reason
string

Failure reason if the API failed.

results

API response data

return
boolean

Whether the API returned successfully