data [required]
\nobject
Incident type data for a patch request.
attributes [required]
\nobject
Incident type's attributes for updates.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
When true, this incident type will be used as the default type when an incident type is not specified.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Incident data from an import response.
attributes
\nobject
The incident's attributes from an import response.
archived
\ndate-time
Timestamp of when the incident was archived.
case_id
\nint64
The incident case id.
created
\ndate-time
Timestamp when the incident was created.
created_by_uuid
\nstring
UUID of the user who created the incident.
creation_idempotency_key
\nstring
A unique key used to ensure idempotent incident creation.
customer_impact_end
\ndate-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
\nstring
A summary of the impact customers experienced during the incident.
customer_impact_start
\ndate-time
Timestamp when customers began being impacted by the incident.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by_uuid
\nstring
UUID of the user who declared the incident.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields attached to incidents.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
type
\nenum
Type of the single value field definitions. \nAllowed enum values: dropdown,textbox
default: dropdown
value
\nstring
The single value selected for this field.
Option 2
\nobject
A field with potentially multiple values selected.
type
\nenum
Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
\n[string]
The multiple values selected for this field.
incident_type_uuid
\nstring
A unique identifier that represents an incident type.
is_test
\nboolean
A flag indicating whether the incident is a test incident.
last_modified_by_uuid
\nstring
UUID of the user who last modified the incident.
modified
\ndate-time
Timestamp when the incident was last modified.
non_datadog_creator
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
notification_handles
\n[object]
Notification handles that will be notified of the incident during update.
display_name
\nstring
The name of the notified handle.
handle
\nstring
The handle used for the notification. This includes an email address, Slack channel, or workflow.
public_id
\nint64
The monotonically increasing integer ID for the incident.
resolved
\ndate-time
Timestamp when the incident's state was last changed from active or stable to resolved or completed.
severity
\nenum
The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5
state
\nstring
The state of the incident.
title [required]
\nstring
The title of the incident, which summarizes what happened.
visibility
\nstring
The incident visibility status.
id [required]
\nstring
The incident's ID.
relationships
\nobject
The incident's relationships from an import response.
attachments
\nobject
A relationship reference for attachments.
data [required]
\n[object]
An array of incident attachments.
id [required]
\nstring
A unique identifier that represents the attachment.
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
declared_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
impacts
\nobject
Relationship to impacts.
data [required]
\n[object]
An array of incident impacts.
id [required]
\nstring
A unique identifier that represents the impact.
type [required]
\nenum
The incident impacts type. \nAllowed enum values: incident_impacts
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
integrations
\nobject
A relationship reference for multiple integration metadata objects.
data [required]
\n[object]
Integration metadata relationship array
id [required]
\nstring
A unique identifier that represents the integration metadata.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
responders
\nobject
Relationship to incident responders.
data [required]
\n[object]
An array of incident responders.
id [required]
\nstring
A unique identifier that represents the responder.
type [required]
\nenum
The incident responders type. \nAllowed enum values: incident_responders
user_defined_fields
\nobject
Relationship to incident user defined fields.
data [required]
\n[object]
An array of user defined fields.
id [required]
\nstring
A unique identifier that represents the responder.
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data for an import request.
attributes [required]
\nobject
The incident's attributes for an import request.
declared
\ndate-time
Timestamp when the incident was declared.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields for which to create initial selections.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
value
\nstring
The single value selected for this field.
Option 2
\nobject
A field with potentially multiple values selected.
value
\n[string]
The multiple values selected for this field.
incident_type_uuid
\nstring
A unique identifier that represents the incident type. If not provided, the default incident type will be used.
resolved
\ndate-time
Timestamp when the incident was resolved. Can only be set when the state field is set to 'resolved'.
title [required]
\nstring
The title of the incident, which summarizes what happened.
visibility
\nenum
The visibility of the incident. \nAllowed enum values: organization,private
default: organization
relationships
\nobject
The relationships for an incident import request.
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
declared_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents