Update a Maintenance event

Request

Modifies an existing Maintenance. Only modified attributes may be passed in payload. All other attributes will remain unchanged.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

maintenance_idstringrequired

id of the requested maintenance

Query

api_versionstring

Api version

Value:"V3-R1"

Bodyapplication/json

titlestring

Title of event.
Can contain only plain text. HTML tags and other forms of formatting are not allowed.

Example:"Title of the event"

start_timestring or null, (date-time)

Timestamp of event start.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

end_timestring or null, (date-time)

Timestamp of event end.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

service_statusesArray of objects

Describes affected services and their statuses.

bodystring

Default:""

Example:"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"

silentboolean

When true notifications are not being sent to subscribers.
Does not impact draft notifications for Team Members.

Default:false

statestring or null

State of Maintenance event:

draft - Not published on Hub Page. Draft will result in draft notifications being sent to Team Members,
published - Published on Hub Page.

Default:"published"

Enum:"draft""published"

suppress_eventsboolean

When true for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published.
Depending on configuration such Incidents will be either:

saved as draft,
ignored.

event_repeatobject or null

Describes recurring maintenance schedules.

event_notificationsArray of objects

Describes additional notifications to be sent at specific offset from maintenance start or end.

recurringobject

Used only for Maintenance events being a part of Recurring Maintenance Schedule. Instructs API how to handle edit of an event that is repeating.

curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/maintenances/{maintenance_id}?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "Title of the event",
    "start_time": "2020-09-01T08:29:00Z",
    "end_time": "2020-09-01T08:29:00Z",
    "service_statuses": [
      {
        "service_id": 1234,
        "status": "down"
      }
    ],
    "body": "Message for an event or event update.<br>\nMay contain basic HTML tags.\n",
    "silent": false,
    "state": "draft",
    "suppress_events": true,
    "event_repeat": {
      "interval": "day",
      "interval_options": {
        "enabled_days": "0,2,5",
        "type": "day_of_month"
      },
      "end_on": "2020-09-01T08:29:00Z"
    },
    "event_notifications": [
      {
        "offset_in_min": -60,
        "offset_type": "start"
      }
    ],
    "recurring": {
      "update_following": true
    }
  }'

Responses

OK

Bodyapplication/json

idstring

authorstring or null

Author email

created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

titlestring

Title of event.
Can contain only plain text. HTML tags and other forms of formatting are not allowed.

Example:"Title of the event"

bodystring

Default:""

Example:"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"

event_repeatobject or null

Describes recurring maintenance schedules.

event_notificationsArray of objects

Describes additional notifications to be sent at specific offset from maintenance start or end.

service_statusesArray of objects

start_timestring or null, (date-time)

Timestamp of event start.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

end_timestring or null, (date-time)

Timestamp of event end.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

flagsBasic flags (object) or Extended flags (object)

One of:

updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

Response

{
  "id": "string",
  "author": "string",
  "created_at": "2020-09-01T08:29:00Z",
  "title": "Title of the event",
  "body": "Message for an event or event update.<br>\nMay contain basic HTML tags.\n",
  "event_repeat": {
    "interval": "day",
    "interval_options": { … },
    "end_on": "2020-09-01T08:29:00Z"
  },
  "event_notifications": [
    { … }
  ],
  "service_statuses": [
    { … }
  ],
  "start_time": "2020-09-01T08:29:00Z",
  "end_time": "2020-09-01T08:29:00Z",
  "flags": {
    "deleted": true,
    "draft": true
  },
  "updated_at": "2020-09-01T08:29:00Z"
}