v1

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

Update an incident type

Update an incident type.

patch/api/v2/incidents/config/types/{incident_type_id}

Path parameters

incident_type_idstring required

The UUID of the incident type.

Request body

Example request

{
  "data": {
    "attributes": {
      "configuration": {
        "allow_workflows": true,
        "create_message": "Create an incident here",
        "slug_source": "default",
        "test_incidents": true
      },
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.",
      "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
      "name": "Security Incident",
      "prefix": "IR"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "incident_types"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "configuration": {
        "allow_workflows": true,
        "create_message": "Create an incident here",
        "slug_source": "default",
        "test_incidents": true
      },
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.",
      "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
      "name": "Security Incident",
      "prefix": "IR"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "google_meet_configuration": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "google_meet_configurations"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "microsoft_teams_configuration": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "microsoft_teams_configurations"
        }
      },
      "zoom_configuration": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "zoom_configurations"
        }
      }
    },
    "type": "incident_types"
  }
}