API Reference

List clients and their backup health

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

Returns a cursor-paginated list of clients whose backup health matches the optional filters. Each item includes history for the last seven calendar days, ending on the tenant's current local date.

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 health history to return, ending on the tenant's current local date. Must be between 1 and 365.

string

Sort order for a single field.

Syntax

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

Supported field

  • client.name

Examples

  • sort=client.name
  • sort=+client.name
  • sort=-client.name
string

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

string

Filter on client.name using the operators below.

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[client.name]=Corp
  • filter[client.name]=eq:Corp
  • filter[client.name]=eq:"Fabrik, LLC"
  • filter[client.name]=eq:"Solty: West"

List examples:

  • filter[client.name]=in:Conto,Fabrik
  • filter[client.name]=in:Conto,"Fabrik, LLC"
Responses

Updated about 1 month ago

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 1 month ago