List maintenance

GET/workspaces/{workspace}/status/maintenance

Returns up to 100 maintenance windows: upcoming ones soonest first, or past ones newest first.

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.

Query parameters

filterenumdefault upcoming
upcoming: scheduled or in progress. past: completed or cancelled. One of upcoming, past, all.

Response

200 OK

Windows plus meta {counts {upcoming, past}, subscribers, timezone}.

idintegerWindow id.
titlestringTitle.
bodystring|nullDetails.
starts_atstringUTC, ISO 8601.
ends_atstringUTC, ISO 8601.
timezonestringZone the times were entered in.
duration_minutesintegerLength.
statusenumStage. One of scheduled, in_progress, completed, cancelled.
status_labelstringLocalized.
notify_subscribersbooleanMaster switch for subscriber emails.
notify_nowbooleanAnnounce when scheduled.
notify_day_beforebooleanRemind the day before.
notify_startbooleanEmail at start.
notify_endbooleanEmail at end.
pause_alertsbooleanDon’t alert on affected monitors during the window.
components[]{id, name}Affected components.

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.

422Unknown filter.

Every error is JSON with a message. See Errors.

Next →Schedule maintenance

curl "https://api.bynh.io/api/v1/workspaces/dokan/status/maintenance?filter=upcoming" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json

{
  "data": [
    {
      "id": 8,
      "title": "Database upgrade",
      "body": "Checkout may be unavailable for up to 20 minutes while we upgrade the database.",
      "starts_at": "2026-10-15T23:00:00+00:00",
      "ends_at": "2026-10-16T00:00:00+00:00",
      "timezone": "Asia/Riyadh",
      "duration_minutes": 60,
      "status": "scheduled",
      "status_label": "Scheduled",
      "notify_subscribers": true,
      "notify_now": true,
      "notify_day_before": true,
      "notify_start": true,
      "notify_end": true,
      "pause_alerts": true,
      "components": [
        {
          "id": 2,
          "name": "Checkout"
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "upcoming": 1,
      "past": 6
    },
    "subscribers": 243,
    "timezone": "Asia/Riyadh"
  }
}

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