Overview

Resources

image: Pull backup image

Downloads backup image in tar format, stored at locally.

GET https://{device}/api/mgmt.backup/1.0/image

Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

image: Push backup image

Uploads the backup image attached with request body as form-data where key = ‘file’ and value = ‘file object’

POST https://{device}/api/mgmt.backup/1.0/image

Authorization

This request requires authorization.

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

image: Delete backup

Deletes all locally created backups.

DELETE https://{device}/api/mgmt.backup/1.0/image

Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Error Codes

In the event that an error occurs while processing a request, the server will respond with appropriate HTTP status code and additional information in the response body:

{
     "error_id":   "{error identifier}",
     "error_text": "{error description}",
     "error_info": {error specific data structure, optional}
}

The table below lists the possible errors and the associated HTTP status codes that may returned.

Error ID	HTTP Status	Comments
BAD_REQUEST	400	Invalid argument.
AUTH_REQUIRED	401	Authentication required.
AUTH_INVALID_CREDENTIALS	401	Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.
INTERNAL_ERROR	500	Internal error.