Network Edge APIs | Equinix Product Documentation

Get Backups of Device By Uuid

Request

Returns the details of a backup by its unique ID. Authorization checks are performed on the users of this API.

Security

BearerAuth

Path

uuidstringrequired

Unique ID of a backup

Example:3da0a663-20d9-4b8f-8c5d-d5cf706840c8

Payload

// No request payload

Responses

Bodyapplication/json

uuidstring

The unique Id of the device backup.

Example:"4cfb5675-5c3f-4275-adba-0c9e3c26c96b"

namestring

The name of the backup.

Example:"My New Backup"

versionstring

Version of the device

Example:"16.09.02"

typestring

The type of backup.

Value:"CONFIG"

Example:"CONFIG"

statusstring

The status of the backup.

Enum:"COMPLETED""FAILED""IN_PROGRESS"

Example:"COMPLETED"

createdBystring

Created by.

Example:"cust0001"

lastUpdatedDateTimestring, (date-time)

Last updated date.

Example:"2018-01-30T10:30:31Z"

downloadUrlstring

URL where you can download the backup.

Example:"/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download"

deleteAllowedboolean

Whether or not you can delete the backup.

Example:true

restoresArray of objects(PreviousBackups)

deviceUuidstring

Unique Id of the device

Example:"78fb5675-5c3f-4275-adba-0c9e3c26c78c"

Response

{
  "uuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
  "name": "My New Backup",
  "version": "16.09.02",
  "type": "CONFIG",
  "status": "COMPLETED",
  "createdBy": "cust0001",
  "lastUpdatedDateTime": "2018-01-30T10:30:31Z",
  "downloadUrl": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download",
  "deleteAllowed": true,
  "restores": [
    { … }
  ],
  "deviceUuid": "78fb5675-5c3f-4275-adba-0c9e3c26c78c"
}