Skip to content

Update a Maintenance Template

Request

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

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

maintenance_template_idintegerrequired

id of the requested Maintenance Template

Query
api_versionstring

Api version

Value:"V3-R1"
Bodyapplication/json
titlestring or null

Title of event. Can be omitted if body is provided.

Can contain only plain text. HTML tags and other forms of formatting are not allowed.
Templates without title set will ignore event title when applied.

bodystring or null

Title of event. Can be omitted if title is provided.

Can contain basic HTML tags and is being interpreted as HTML.
Templates without body set will ignore event body when applied.

durationinteger or null, [ 1 .. 5999 ]

Duration of maintenance in minutes.
Maximum allowed value is 99h:59min (5999 minutes).

labelsArray of strings

List of labels for this template. Template can have many labels.
If passing just one label, it should still be passed as an array: "labels": ["some label value"].

service_statusesArray of objects

Describes affected services and their statuses.

silentboolean or null

Controls silent parameter value when applying the template:

  • true - Set event silent parameter as true,
  • false - Set event silent parameter as false,
  • null - Do not set event silent parameter.
curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "body": "string",
    "duration": 1,
    "labels": [
      "string"
    ],
    "service_statuses": [
      {
        "service_id": 1234,
        "status": "down"
      }
    ],
    "silent": true
  }'

Responses

OK

Bodyapplication/json
idinteger, >= 1
Example:60
titlestring or null

Title of event.
Templates without title set will ignore event title when applied.

labelsArray of strings

List of labels for this template.

flagsobject
durationinteger or null, [ 1 .. 5999 ]

Duration of maintenance in minutes.

bodystring or null

Title of event.
Templates without body set will ignore event body when applied.

created_atstring, (date-time)

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

Example:"2020-09-01T08:29:00Z"
updated_atstring, (date-time)

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

Example:"2020-09-01T08:29:00Z"
authorstring or null

Author email

service_statusesArray of objects
Response
{
  "id": 60,
  "title": "string",
  "labels": [
    "string"
  ],
  "flags": {
    "deleted": true,
    "silent": true
  },
  "duration": 1,
  "body": "string",
  "created_at": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z",
  "author": "string",
  "service_statuses": [
    { … }
  ]
}