Initiate an Appliance Backup.

Prev Next
Post
/appliances/{id}/backup

Initiate an Appliance Backup. The progress can be followed by polling the Appliance via "GET appliances//backup//status".

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

ID of the object.

Example12699e27-b584-464a-81ee-5b4784b6d425
Body parameters

Appliance Backup parameters.

object
logs
boolean

Whether the Appliance Backup should include syslog or not.

audit
boolean

Whether the Appliance Backup should include the audit logs or not.

notifyUrl
string

URL to send a POST request to notify about the completion of the backup, that it can now be downloaded and deleted.

Responses
202

Appliance Backup has begun.

object
id
string (uuid)

Appliance Backup ID to be used as path parameter to follow the progress.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
400

JSON error. Check the JSON format.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

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.

503

Service unavailable error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.