v1

latestOpenAPI 3.0.02026-08-0650184174.6 KB
Checks

Returns a list overview of all checks.

get/checks

Query parameters

limitinteger

Limits the number of returned probes to the specified quantity. (Max value is 25000)

offsetinteger

Offset for listing. (Requires limit.)

showencryptionboolean

If set, show encryption setting for each check

include_tagsboolean

Include tag list for each check. Tags can be marked as "a" or "u", for auto tagged or user tagged.

include_severityboolean

Include severity level for each check.

tagsstring

Tag list separated by commas. As an example "nginx,apache" would filter out all responses except those tagged nginx or apache

Response

Successful operation

Example response

{
  "checks": [
    {
      "id": 100,
      "name": "mycheck",
      "lasterrortime": 1297446423,
      "lasttesttime": 1300977363,
      "lastresponsetime": 355,
      "lastdownstart": 1300977363,
      "lastdownend": 1300977463,
      "tags": [
        {
          "name": "apache",
          "type": "a",
          "count": 2
        }
      ]
    }
  ],
  "counts": {
    "total": 55,
    "limited": 3,
    "filtered": 5
  }
}