Get Backup Status

Get Backup Status

Get status of active backup operations

Request
URI
GET
https://nsxmanager.your.domain/api/v1/cluster/backups/status
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns CurrentBackupOperationStatus of type(s) application/json 
{
    "current_step": "string",
    "backup_id": "string",
    "current_step_message": "string",
    "end_time": 0,
    "operation_type": "string",
    "start_time": 0
}
string
current_step
Optional

current_step

Possible values are : BACKUP_CREATING_CLUSTER_BACKUP, BACKUP_CREATING_NODE_BACKUP,
string
backup_id
Optional

backup_id

string
current_step_message
Optional

current_step_message

integer As int64 As int64
end_time
Optional

Time when operation is expected to end

string
operation_type
Required

operation_type

Possible values are : NONE, BACKUP,
integer As int64 As int64
start_time
Optional

Time when operation was started


default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Nsx Admin Operations
PUT
Configure Backup Config
POST
Create Cluster Backup
POST
Create Cluster Restore
POST
Create Node Backup
POST
Create Node Restore
GET
Get Backup Config
GET
Get Backup History
GET
Get Backup Status
POST
Request Onetime Backup
POST
Request Onetime Inventory Summary