Skip to content
bynhDocs
Log in

Cancel maintenance

POST/workspaces/{workspace}/status/maintenance/{maintenance}/cancel

Cancels a window that hasn’t started. If subscribers were already told about it, they’re emailed that it’s off.

Authentication

Send an API token as a bearer token. This endpoint needs a read and write token, made by an editor, admin or owner. 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.

  • maintenanceintegerRequired

    Window id.

Response

200 OK

The window.

  • 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.
403The token is read-only (message: “This token is read-only. Create a read and write token to make changes.”). Or: The token’s owner is a viewer (“Viewers can read everything but can’t change it.”), or the workspace’s editing is paused (a billing message, e.g. “Your trial has ended, so editing is paused. …”).
404The token belongs to another workspace, or its owner is no longer a member.
422{"message": "Only a window that hasn’t started can be cancelled."} (no errors object).

Every error is JSON with a message. See Errors.

Next →List subscribers
curl -X POST "https://api.bynh.io/api/v1/workspaces/dokan/status/maintenance/1/cancel" \
  -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": "cancelled",
    "status_label": "Cancelled",
    "notify_subscribers": true,
    "notify_now": true,
    "notify_day_before": true,
    "notify_start": true,
    "notify_end": true,
    "pause_alerts": true,
    "components": [
      {
        "id": 2,
        "name": "Checkout"
      }
    ]
  }
}

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