Backup
prev Chapter 3 /sdn/v2.0 next

Backup

Backup/status

Get backup status

Sample request 

Get status of the ongoing or last completed backup

GET /sdn/v2.0/backup/status

There is no request body for this API.

Sample response 

SUCCESS, IN_PROGRESS, or FAILED

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Bad Method (405), Service Unavailable (503)

Backup/checksum

Get backup checksum

Sample request 

Get the SHA-256 checksum of the backup file currently stored on the controller

GET /sdn/v2.0/backup/checksum

There is no request body for this API.

Sample response 

1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Bad Method (405) ,Precondition Failed (412), Service Unavailable (503)

Backup/

Get backup contents

Sample request 

Get the backup file currently stored on the controller

GET /sdn/v2.0/backup

There is no request body for this API.

Sample response 

A binary stream that can be redirected to a file.

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Bad Method (405), Precondition Failed (412), Service Unavailable (503)

Start backup

This API is asynchronous.

Sample request 

Start the backup on the controller

POST /sdn/v2.0/backup

There is no request body for this API.

Sample response 

A Location header which redirects the user the status URI (i.e. https://10.12.13.14/sdn/v2.0/backup/status)

Response codes 

  • Accepted (202)

  • Error: Unauthorized (401), Not Found (404), Bad Method (405), Precondition Failed (412), Service Unavailable (503)

prev up next
Team home Restore