Retrieve a Maintenance event

Request

Returns data about single maintenance event.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

maintenance_idstringrequired

id of the requested maintenance

Query

extendstring

Specifies which properties should be expanded.
Expanded properties contains more detailed information which is less frequently needed in typical usage.
Currently supported only for flags.

Example:extend=flags

api_versionstring

Api version

Value:"V3-R1"

curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/maintenances/{maintenance_id}?extend=flags&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

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"
}