Incident Templates

Get incident templates.

get

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0

max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50

Responses

200

The incident templates

application/json

get

/incident-templates

HTTPcURLJavaScriptPython

GET /api/incident-templates HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The incident templates

[
  {
    "id": 1,
    "name": "text",
    "summary": "text",
    "status": "INVESTIGATING",
    "message": "text",
    "sendNotification": true,
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
]

Create a new incident template.

post

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Body

application/json

idnumberOptional

namestringOptional

summarystringOptional

statusstring · enumOptional

the incident status

Possible values:

messagestringOptional

sendNotificationbooleanOptional

Responses

200

The newly created incident template

application/json

post

/incident-templates

HTTPcURLJavaScriptPython

POST /api/incident-templates HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "id": 1,
  "name": "text",
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

200

The newly created incident template

{
  "id": 1,
  "name": "text",
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Get a specific incident template.

get

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

200

The requested incident template

application/json

get

/incident-templates/{id}

HTTPcURLJavaScriptPython

GET /api/incident-templates/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The requested incident template

{
  "id": 1,
  "name": "text",
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Update the specific incident template

put

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Body

application/json

idnumberOptional

namestringOptional

summarystringOptional

statusstring · enumOptional

the incident status

Possible values:

messagestringOptional

sendNotificationbooleanOptional

Responses

200

The updated incident template

application/json

put

/incident-templates/{id}

HTTPcURLJavaScriptPython

PUT /api/incident-templates/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "id": 1,
  "name": "text",
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

200

The updated incident template

{
  "id": 1,
  "name": "text",
  "summary": "text",
  "status": "INVESTIGATING",
  "message": "text",
  "sendNotification": true,
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Remove a specific incident template.

delete

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

204

Empty body delete response

delete

/incident-templates/{id}

HTTPcURLJavaScriptPython

DELETE /api/incident-templates/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

204

Empty body delete response

No content