API Reference

List backup devices

get
https://api.scalepad.com/backup-radar/v3/clients/devices

Returns a cursor-paginated list of backup devices whose names match the optional filters. Each item includes the device's last result and per-day SLA history for the requested window, ending on the tenant's current local date.

Devices are returned whether or not their Backup Radar company is mapped to a ScalePad company. When a device is not mapped, the ScalePad-specific fields (device_id, device_name, and the client name/client_id) are null.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 200
Defaults to 100

Number of items per page. Must be between 1 and 200. Defaults to 100 when omitted.

integer
1 to 365

Number of calendar days of backup history to return, ending on the tenant's current local date. Must be between 1 and 365.

string
^[+-]?(device_name|device_id)$

Sort order for a single field.

Syntax

  • field or +field: ascending
  • -field: descending

Supported fields

  • device_name
  • device_id

Examples

  • sort=device_name
  • sort=+device_name
  • sort=-device_name
  • sort=device_id
  • sort=-device_id
string

The cursor from the previous response (next_cursor). Pass it here to fetch the next page.

string
^(eq|in):.+$

Filter on device_name (the ScalePad device name) using the operators below. Devices that are not mapped to a ScalePad device are excluded when this filter is applied.

Operators:

eq (equality; this is the default) and in (match any value in the list).

Use double quotes for values when the value contains a comma, a colon, or spaces.

Equality examples:

  • filter[device_name]=Server-01
  • filter[device_name]=eq:Server-01
  • filter[device_name]=eq:"Server, Primary"
  • filter[device_name]=eq:"Server: Primary"

List examples:

  • filter[device_name]=in:Device-01,Device-02
  • filter[device_name]=in:Device-01,"Device, Primary"
string
^(eq|in):.+$

Filter on device_id (ScalePad device id) using the operators below. Devices that are not mapped to a ScalePad device are excluded when this filter is applied.

Operators:

eq (equality; this is the default) and in (match any value in the list).

Equality examples:

  • filter[device_id]=9999999b-6d54-44d7-b0b7-5600849ca5a4
  • filter[device_id]=eq:9999999b-6d54-44d7-b0b7-5600849ca5a4

List examples:

  • filter[device_id]=in:9999999b-6d54-44d7-b0b7-5600849ca5a4,0aaaaaab-1111-2222-3333-444444444444
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?