ServiceMaintenanceResource

Create a service maintenance window

Creates a maintenance window for status-page services.

Required API key permissions

  • Scope: service-maintenance:create
  • Accepted key types: organization API key (org-wide), personal access token (org-wide)
  • Access: Operates on a single organization. Pass organizationId when your API key spans multiple organizations.
  • Required organization role (user-linked keys only): Member
  • Organization API keys are not subject to organization or team role checks.
post/api/public/v1/service-maintenance

Request

Query parameters

organizationIdstring uuid
provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

displayNamestring nullable
serviceIdsstring[] nullable
timeZoneIdstring nullable
publicDescriptionstring nullable
startstring date-time nullable
endstring date-time nullable

Response

OK

idstring uuid
displayNamestring nullable
organizationIdstring uuid
serviceIdsstring[] nullable
timeZoneIdstring nullable
startstring date-time nullable
endstring date-time nullable
publicDescriptionstring nullable
isProvisionedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.