Incident Templates
Authorizations
Query parameters
start-indexinteger · int32OptionalDefault:
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
max-resultsinteger · int32 · max: 100OptionalDefault:
the maximum number of results when paging through a list of entities.
50
Responses
200
The incident templates
application/json
get
GET /api/incident-templates HTTP/1.1
Host:
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"
}
]
}
]
Authorizations
Body
idnumberOptional
namestringOptional
summarystringOptional
statusstring · enumOptionalPossible values:
the incident status
messagestringOptional
sendNotificationbooleanOptional
Responses
200
The newly created incident template
application/json
post
POST /api/incident-templates HTTP/1.1
Host:
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"
}
]
}
Authorizations
Path parameters
idnumberRequired
entity ID
Responses
200
The requested incident template
application/json
get
GET /api/incident-templates/{id} HTTP/1.1
Host:
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"
}
]
}
Authorizations
Path parameters
idnumberRequired
entity ID
Body
idnumberOptional
namestringOptional
summarystringOptional
statusstring · enumOptionalPossible values:
the incident status
messagestringOptional
sendNotificationbooleanOptional
Responses
200
The updated incident template
application/json
put
PUT /api/incident-templates/{id} HTTP/1.1
Host:
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"
}
]
}
Was this helpful?