v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Status Pages

Update maintenance

Updates an existing maintenance's attributes.

patch/api/v2/statuspages/{page_id}/maintenances/{maintenance_id}

Path parameters

page_idstring uuid required

The ID of the status page.

maintenance_idstring uuid required

The ID of the maintenance.

Query parameters

notify_subscribersboolean

Whether to notify page subscribers of the maintenance.

includestring

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Request body

Example request

{
  "data": {
    "attributes": {
      "completed_date": "2026-02-18T20:01:13.332360075Z",
      "in_progress_description": "We are currently performing maintenance on the API to improve performance for 40 minutes.",
      "scheduled_description": "We will be performing maintenance on the API to improve performance for 40 minutes.",
      "start_date": "2026-02-18T19:21:13.332360075Z",
      "title": "API Maintenance"
    },
    "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
    "type": "maintenances"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "status": "operational"
        }
      ],
      "updates": [
        {
          "components_affected": [
            {
              "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
              "status": "operational"
            }
          ]
        }
      ]
    },
    "relationships": {
      "created_by_user": {
        "data": {
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "type": "status_pages"
        }
      }
    },
    "type": "maintenances"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}