Skip to content
bynhDocs
Log in

List monitors

GET/workspaces/{workspace}/status/monitors

Returns every monitor, sorted by name, with its current state, 90-day uptime and daily bars.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Response

200 OK

Not paginated.

  • idintegerMonitor id.
  • namestringName.
  • typeenumCheck type. One of http, keyword, tcp, heartbeat.
  • type_labelstringLocalized (HTTPS, Keyword, Port, Heartbeat).
  • targetstringURL without scheme, host:port, or “every 5 minutes” for heartbeats (localized).
  • statusenumCurrent state. One of pending, up, slow, down, paused.
  • status_labelstringLocalized.
  • status_changed_atstring|nullISO 8601.
  • uptime_90dnumber|nullAverage of daily uptime percentages over checked days.
  • response_msinteger|nullLast response time.
  • slow_after_msinteger|nullSlow threshold.
  • interval_secondsintegerCheck interval.
  • last_checked_atstring|nullISO 8601.
  • last_errorstring|nullLast failure summary.
  • tagsarray<string>Lower-case tags.
  • component{id, name, group_id}|nullStatus page component it drives.
  • barsarray90 entries, oldest first: {day: YYYY-MM-DD, uptime: percent 0–100 with 3 decimals or null if not checked that day, incident_minutes: integer}.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.
404The token belongs to another workspace, or its owner is no longer a member.

Every error is JSON with a message. See Errors.

Next →Create a monitor
curl "https://api.bynh.io/api/v1/workspaces/dokan/status/monitors" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": [
    {
      "id": 4,
      "name": "Checkout API",
      "type": "http",
      "type_label": "HTTPS",
      "target": "api.dokan.sa/health",
      "status": "up",
      "status_label": "Up",
      "status_changed_at": "2026-09-28T02:14:00+00:00",
      "uptime_90d": 99.982,
      "response_ms": 182,
      "slow_after_ms": 1500,
      "interval_seconds": 60,
      "last_checked_at": "2026-10-01T07:59:01+00:00",
      "last_error": null,
      "tags": [
        "payments"
      ],
      "component": {
        "id": 2,
        "name": "Checkout",
        "group_id": 1
      },
      "bars": [
        {
          "day": "2026-07-04",
          "uptime": 100,
          "incident_minutes": 0
        },
        {
          "day": "2026-10-01",
          "uptime": 99.931,
          "incident_minutes": 1
        }
      ]
    }
  ]
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.