Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Endpoints

List endpoint backups

Returns the details of last successful backups on user devices for the last 30 days.

get/endpoints/v1/backups

Query parameters

lastSuccessfulboolean required

Provides details of the last successful backup for a device. Currently, only 'True' is the supported value for this parameter.

deviceIDinteger

Filter to get list of last successful backups for a particular device using its unique ID. Get the ID of a device using the ‘List all devices’ API.

userIDinteger

Filter to get list of last successful backups on devices owned by a particular user using their user ID. Get the ID of a user using the ‘List all users’ API.

pageTokenstring

The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.

minBackupStartTimestring date-time

Filter to list successful backups that started after a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ

maxBackupStartTimestring date-time

Filter to list successful backups that started before a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ

minBackupEndTimestring date-time

Filter to list successful backups that ended after a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ

maxBackupEndTimestring date-time

Filter to list successful backups that ended before a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ

Response

OK

totalSizeinteger
nextPageTokenstring

The token to access next page of results. This parameter will be empty for the last page of results.

Example response

{
  "totalSize": 1,
  "nextPageToken": "MTExMQ==",
  "backups": [
    {
      "deviceID": 12345,
      "filesBackedUp": 124,
      "bytesTransferred": 23456,
      "filesMissed": 50,
      "snapshotSize": "2546 MB",
      "startTime": "2019-10-25T00:00:00Z",
      "endTime": "2019-10-25T00:00:00Z"
    }
  ]
}