ServiceMaintenanceResource

Get a service maintenance window by ID

Returns a single status-page service maintenance window.

Required API key permissions

  • Scope: service-maintenance:get
  • 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.
get/api/public/v1/service-maintenance/{id}

Request

Path parameters

idstring uuid required

Query parameters

organizationIdstring uuid

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 2 revisions of this API.