data [required]
\n[object]
An array of incidents.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\n[object]
An array of incidents.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\nobject
Data returned by an incident search.
attributes
\nobject
Attributes returned by an incident search.
facets [required]
\nobject
Facet data for incidents returned by a search query.
commander
\n[object]
Facet data for incident commander users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
created_by
\n[object]
Facet data for incident creator users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
fields
\n[object]
Facet data for incident property fields.
aggregates
\nobject
Aggregate information for numeric incident data.
max
\ndouble
Maximum value of the numeric aggregates.
min
\ndouble
Minimum value of the numeric aggregates.
facets [required]
\n[object]
Facet data for the property field of an incident.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
name [required]
\nstring
Name of the incident property field.
impact
\n[object]
Facet data for incident impact attributes.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
last_modified_by
\n[object]
Facet data for incident last modified by users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
postmortem
\n[object]
Facet data for incident postmortem existence.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
responder
\n[object]
Facet data for incident responder users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
severity
\n[object]
Facet data for incident severity attributes.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
state
\n[object]
Facet data for incident state attributes.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
time_to_repair
\n[object]
Facet data for incident time to repair metrics.
aggregates [required]
\nobject
Aggregate information for numeric incident data.
max
\ndouble
Maximum value of the numeric aggregates.
min
\ndouble
Minimum value of the numeric aggregates.
name [required]
\nstring
Name of the incident property field.
time_to_resolve
\n[object]
Facet data for incident time to resolve metrics.
aggregates [required]
\nobject
Aggregate information for numeric incident data.
max
\ndouble
Maximum value of the numeric aggregates.
min
\ndouble
Minimum value of the numeric aggregates.
name [required]
\nstring
Name of the incident property field.
incidents [required]
\n[object]
Incidents returned by the search.
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
total [required]
\nint32
Number of incidents returned by the search.
type
\nenum
Incident search result type. \nAllowed enum values: incidents_search_results
default: incidents_search_results
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
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Data returned by an incident search.
attributes
\nobject
Attributes returned by an incident search.
facets [required]
\nobject
Facet data for incidents returned by a search query.
commander
\n[object]
Facet data for incident commander users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
created_by
\n[object]
Facet data for incident creator users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
fields
\n[object]
Facet data for incident property fields.
aggregates
\nobject
Aggregate information for numeric incident data.
max
\ndouble
Maximum value of the numeric aggregates.
min
\ndouble
Minimum value of the numeric aggregates.
facets [required]
\n[object]
Facet data for the property field of an incident.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
name [required]
\nstring
Name of the incident property field.
impact
\n[object]
Facet data for incident impact attributes.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
last_modified_by
\n[object]
Facet data for incident last modified by users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
postmortem
\n[object]
Facet data for incident postmortem existence.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
responder
\n[object]
Facet data for incident responder users.
count
\nint32
Count of the facet value appearing in search results.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
uuid
\nstring
ID of the user.
severity
\n[object]
Facet data for incident severity attributes.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
state
\n[object]
Facet data for incident state attributes.
count
\nint32
Count of the facet value appearing in search results.
name
\nstring
The facet value appearing in search results.
time_to_repair
\n[object]
Facet data for incident time to repair metrics.
aggregates [required]
\nobject
Aggregate information for numeric incident data.
max
\ndouble
Maximum value of the numeric aggregates.
min
\ndouble
Minimum value of the numeric aggregates.
name [required]
\nstring
Name of the incident property field.
time_to_resolve
\n[object]
Facet data for incident time to resolve metrics.
aggregates [required]
\nobject
Aggregate information for numeric incident data.
max
\ndouble
Maximum value of the numeric aggregates.
min
\ndouble
Minimum value of the numeric aggregates.
name [required]
\nstring
Name of the incident property field.
incidents [required]
\n[object]
Incidents returned by the search.
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
total [required]
\nint32
Number of incidents returned by the search.
type
\nenum
Incident search result type. \nAllowed enum values: incidents_search_results
default: incidents_search_results
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
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\nobject
Incident data from a response.
attributes
\nobject
The incident's attributes from a 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.
customer_impact_duration
\nint64
Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.
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.
customer_impacted
\nboolean
A flag indicating whether the incident caused customer impact.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
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.
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 incident.
time_to_detect
\nint64
The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.
time_to_internal_response
\nint64
The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair
\nint64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve
\nint64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
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 a 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
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
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\n[object]
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Option 1
\nobject
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
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
data
\nobject
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Option 1
\nobject
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
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
data
\nobject
attributes
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
id
\nstring
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data
\nobject
Attachment data for a create request.
attributes
\nobject
The attributes for creating an attachment.
attachment
\nobject
The attachment object for creating an attachment.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
id
\nstring
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data
\nobject
attributes [required]
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
attachment_type
\nenum
modified
\ndate-time
id [required]
\nstring
relationships [required]
\nobject
last_modified_by_user
\nobject
data [required]
\nobject
id [required]
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Option 1
\nobject
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Attachment data from a response.
attributes [required]
\nobject
The attachment's attributes.
attachment
\nobject
The attachment object.
documentUrl
\nstring
The URL of the attachment.
title
\nstring
The title of the attachment.
attachment_type
\nenum
The type of the attachment. \nAllowed enum values: postmortem,link
modified
\ndate-time
Timestamp when the attachment was last modified.
id [required]
\nstring
The unique identifier of the attachment.
relationships [required]
\nobject
The attachment's resource relationships.
incident
\nobject
Relationship to incident.
data [required]
\nobject
Relationship to incident object.
id [required]
\nstring
A unique identifier that represents the incident.
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
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
data
\nobject
attributes
\nobject
attachment
\nobject
documentUrl
\nstring
title
\nstring
id
\nstring
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data
\nobject
Attachment data for an update request.
attributes
\nobject
The attributes for updating an attachment.
attachment
\nobject
The updated attachment object.
documentUrl
\nstring
The updated URL for the attachment.
title
\nstring
The updated title for the attachment.
id
\nstring
The unique identifier of the attachment.
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments