Get the status of a Appliance Backup.

Prev Next
Get
/appliances/{id}/backup/{backupId}/status

Get the status of the given Appliance Backup ID. If the status is "done", it can be downloaded using "GET appliances//backup/".

Security
HTTP
Type bearer
Path parameters
id
string (uuid) Required

ID of the object.

Example12699e27-b584-464a-81ee-5b4784b6d425
backupId
string (uuid) Required

The Appliance Backup ID given in the initiation response.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
Responses
200

Current status of the Applince Backup.

object

Backups status.

encoding
string

Encoding used for the output field

Valid values[ "utf-8", "base64" ]
output
string

The output of the command. Must be checked if result is failure

result
string

Only set when status is done.

Valid values[ "failure", "success" ]
message
string

A free text field that shows what internally the backup is doing.

status
string

Current status of the Appliance Backup.

Valid values[ "processing", "done" ]
401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

404

The requested resource can not be found.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

412

Appliance is not in the right state for this operation.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.