OPopenstatus
maintenance

Create a maintenance

Changed on
post/maintenance

Request

  • Base URL
    https://api.openstatus.dev (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-openstatus-key

Request body

titlestring required

The title of the maintenance

messagestring required

The newest timeline update. On create it becomes the first update; on update it rewrites the newest one.

fromstring date-time nullable required

When the maintenance starts

tostring date-time nullable required

When the maintenance ends

monitorIdsnumber[]

IDs of affected monitors

pageIdnumber required

The id of the status page this maintenance belongs to

Example request

{
  "title": "Database Upgrade",
  "message": "Upgrading database to improve performance"
}

Response

Create a maintenance

idnumber required

The id of the maintenance

titlestring required

The title of the maintenance

messagestring required

The newest timeline update. On create it becomes the first update; on update it rewrites the newest one.

fromstring date-time nullable required

When the maintenance starts

tostring date-time nullable required

When the maintenance ends

monitorIdsnumber[]

IDs of affected monitors

pageIdnumber required

The id of the status page this maintenance belongs to

Example response

{
  "id": 1,
  "title": "Database Upgrade",
  "message": "Upgrading database to improve performance"
}

Changes

  • 19ec065a8e13Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

  • a3ef7e6cc6acRevision changes
    • breaking

      the response's property format changed from date to date-time for status

    • breaking

      the response's property format changed from date to date-time for status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      the request property format was generalized from date to date-time

    • info

      the request property format was generalized from date to date-time

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status