Network Edge APIs | Equinix Product Documentation

Device-Backup-and-Restore

APIs for managing backups and restoration of virtual devices.

Operations

Returns the backups of a virtual device. Authorization checks are performed on the users of this API.

Security

BearerAuth

projectIdsstring

If projectIds are different from default projectIds, must pass a projectIds parameter

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

virtualDeviceUuidstring

Unique ID of a virtual device

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

statusstring

An array of status values

Enum:"COMPLETED""FAILED""IN_PROGRESS"

Example:status=COMPLETED

offsetinteger, (int32)

Specifies where to start a page. It is the starting point of the collection returned from the server.

Default:0

Example:offset=0

limitinteger, (int32)

Specifies the page size.

Default:20

Example:limit=20

Payload

// No request payload

Bodyapplication/json

paginationobject(PaginationResponse)required

dataArray of objects(DeviceBackupInfoVerbose)required

Array of available backups

Response

{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1
  },
  "data": [
    { … }
  ]
}