Set Incident Type Settings
The POST api/v1/settings endpoint allows configuring of one or many incident type settings for a given incident type and severity.
Headers
Authorization: Bearer TOKEN content-type: application/json
URL
https://\<customer\>.blameless.io/api/v1/settings
Data
{
"scopeEntityId": "type one-default",
"scopeEntityType": "incident-type-severity",
"settings":
{
"org.incident.private": false,
"org.incident.naming-scheme": "NUMERIC",
}
}
| Property | Type | Required | Description |
|---|---|---|---|
| Method | GET | ||
| Customer | string | Yes | The slug of your organization cluster |
| Path | String | Yes | /api/v1/incidents/<incidentId> |
| Auth | Bearer with valid authorization token | ||
| Path Parameters | Integer | Yes | The incident ID |
| scopeEntityId | string | Yes | Either incident-type or incident-type-severity; Concatenation of the incident type and severity separated by a dash. Use default for severity if not referencing a specific severity. |
| settings | string | Yes | Key/value pairs of setting IDs and the values to set. |
Example Request
curl \\
\-H "Authorization: Bearer *****" \\
\-H "Content-Type: application/json" \\
\-X POST \\
"https://cruise.blameless.io/api/v1/settings"
\-d '{"scopeEntityId": "type one-default", "scopeEntityType":
"incident-type-severity", "settings": {"org.incident.private": false,
"org.incident.naming-scheme": "NUMERIC"}}'
Example Response
{
"ok": true,
"success": [
"org.incident.private",
"org.incident.naming-scheme",
],
"failure": {},
}