v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Incidents

Create global incident handle

Create a new global incident handle.

post/api/v2/incidents/config/global/incident-handles

Query parameters

includestring
Example:created_by_user,last_modified_by_user,commander_user,incident_type

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

Request body

Example request

{
  "data": {
    "attributes": {
      "fields": {
        "severity": [
          "SEV-1"
        ]
      },
      "name": "@incident-sev-1"
    },
    "id": "b2494081-cdf0-4205-b366-4e1dd4fdf0bf",
    "relationships": {
      "commander_user": {
        "data": {
          "id": "f7b538b1-ed7c-4e84-82de-fdf84a539d40",
          "type": "incident_types"
        }
      },
      "incident_type": {
        "data": {
          "id": "f7b538b1-ed7c-4e84-82de-fdf84a539d40",
          "type": "incident_types"
        }
      }
    },
    "type": "incidents_handles"
  }
}

Response

Created

Example response

{
  "data": {
    "attributes": {
      "created_at": "2026-01-13T17:15:52.726905Z",
      "fields": {
        "severity": [
          "SEV-1"
        ]
      },
      "modified_at": "2026-01-13T17:15:52.726905Z",
      "name": "@incident-sev-1"
    },
    "id": "12ceee6d-a7c0-4407-bc54-30e54140d7f0",
    "relationships": {
      "commander_user": {
        "data": {
          "id": "f7b538b1-ed7c-4e84-82de-fdf84a539d40",
          "type": "incident_types"
        }
      },
      "created_by_user": {
        "data": {
          "id": "f7b538b1-ed7c-4e84-82de-fdf84a539d40",
          "type": "incident_types"
        }
      },
      "incident_type": {
        "data": {
          "id": "f7b538b1-ed7c-4e84-82de-fdf84a539d40",
          "type": "incident_types"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "f7b538b1-ed7c-4e84-82de-fdf84a539d40",
          "type": "incident_types"
        }
      }
    },
    "type": "incidents_handles"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}