DAdatadog
Incidents

List incident user-defined roles

List all user-defined roles for incidents.

get/api/v2/incidents/config/user-defined-roles

Request

Query parameters

filter[incident-type]string uuid
Example:00000000-0000-0000-0000-000000000001

Filter roles by incident type UUID.

includestring
Example:created_by_user,last_modified_by_user,incident_type

Comma-separated list of related resources to include in the response.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "created": "2024-01-01T00:00:00.000Z",
        "description": "The technical lead for the incident.",
        "modified": "2024-01-01T00:00:00.000Z",
        "name": "Tech Lead",
        "policy": {
          "is_single": true
        }
      },
      "id": "00000000-0000-0000-0000-000000000002",
      "relationships": {
        "created_by_user": {
          "data": {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "users"
          }
        },
        "incident_type": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000001",
            "type": "incident_types"
          }
        },
        "last_modified_by_user": {
          "data": {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "users"
          }
        }
      },
      "type": "incident_user_defined_roles"
    }
  ],
  "included": [
    {
      "type": "users"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.