List all existing monitors

Returns list of all your monitors.

GET https://uptime.betterstack.com/api/v2/monitors

Query parameters

url

string

Filter monitors by their URL property

pronounceable_name

string

Filter monitors by their pronounceable name property

per_page

integer

Definite a number of monitors listed per one call. Maximum = 250, default = 50.

Headers

Authorization

required string

Bearer $TEAM_TOKEN

200

Returns list of existing monitors.

The status attribute can have one of the following values:
paused - the monitor was paused
pending - the monitor was just created and it's waiting for the first check
maintenance - the monitor is paused because it is currently in its maintenance period
up - checks are passing
validating - service seems to be back up, but the recovery_period since the last failed check still hasn't passed
down - checks are failing

If an escalation policy is set (policy_id) then the simple escalation policy settings (call, sms, email, push) are ignored.

Response body

{
  "data": [
    {
      "id": "2",
      "type": "monitor",
      "attributes": {
        "url": "https://uptime.betterstack.com",
        "pronounceable_name": "Uptime homepage",
        "monitor_type": "keyword",
        "monitor_group_id": "12345",
        "last_checked_at": "2020-09-01T14:17:46.000Z",
        "status": "up",
        "required_keyword": "We call you",
        "verify_ssl": true,
        "check_frequency": 30,
        "call": true,
        "sms": true,
        "email": true,
        "push": true,
        "team_wait": null,
        "http_method": "get",
        "request_timeout": 15,
        "recovery_period": 0,
        "request_headers": [
          {
            "id": "123",
            "name": "Content-Type",
            "value": "application/xml"
          }
        ],
        "request_body": "",
        "paused_at": null,
        "created_at": "2020-02-18T13:38:16.586Z",
        "updated_at": "2020-09-08T13:10:20.202Z",
        "ssl_expiration": 7,
        "domain_expiration": 14,
        "regions": [
          "us",
          "eu",
          "as",
          "au"
        ],
        "maintenance_from": "01:02:00",
        "maintenance_to": "03:04:00",
        "maintenance_timezone": "Amsterdam",
        "maintenance_days": [
          "mon",
          "tue",
          "wed",
          "thu",
          "fri",
          "sat",
          "sun"
        ],
        "port": null,
        "confirmation_period": 120,
        "expected_status_codes": [

        ]
      }
    }
  ],
  "pagination": {
    "first": "https://uptime.betterstack.com/api/v2/monitors?page=1",
    "last": "https://uptime.betterstack.com/api/v2/monitors?page=16",
    "prev": null,
    "next": "https://uptime.betterstack.com/api/v2/monitors?page=2"
  }
}

Example cURL

Example

Copied!

curl --request GET \
  --url https://uptime.betterstack.com/api/v2/monitors \
  --header "Authorization: Bearer $TEAM_TOKEN"

Example: Filter by URL

Copied!

curl --request GET \
  --url https://uptime.betterstack.com/api/v2/monitors?url=https://google.com \
  --header "Authorization: Bearer $TEAM_TOKEN"

Don't have your API token yet?

Please, see obtaining an API token

Looking for the details of a specific parameter?

Explore the list of all monitor API parameters