Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
    3. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
      1. Monitors API
        1. List monitors GET
        2. Get monitor GET
        3. Monitor response times GET
        4. Monitor availability GET
        5. Create monitor POST
        6. Update monitor PATCH
        7. Remove monitor DELETE
        8. Response attributes
      2. Monitor groups API
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations

Get monitor

Returns a single monitor.

GET https://uptime.betterstack.com/api/v2/monitors/{monitor_id}

URL parameters

monitor_id
required string

The ID of the monitor you want to get

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single monitor.


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": "123456789",
    "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",
      "policy_id": null,
      "expiration_policy_id": null,
      "team_name": "Test team",
      "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": [],
      "environment_variables": {}
    }
  }
}
404

Response body

{
  "errors": "Resource with provided ID was not found"
}


Example cURL

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


Previous article

List monitors

Next article

Monitor response times