data [required]
\nobject
Data object in the global incident settings request.
attributes
\nobject
Global incident settings attributes
analytics_dashboard_id
\nstring
The analytics dashboard ID
type [required]
\nenum
Global incident settings resource type \nAllowed enum values: incidents_global_settings
data [required]
\n[object]
The NotificationRuleArray data.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
meta
\nobject
Response metadata.
pagination
\nobject
Pagination metadata.
next_offset
\nint64
The offset for the next page of results.
offset
\nint64
The current offset in the results.
size
\nint64
The number of results returned per page.
data [required]
\nobject
Google Chat configuration data in a response.
attributes [required]
\nobject
Attributes of a Google Chat configuration.
created_at [required]
\ndate-time
Timestamp when the configuration was created.
domain_id [required]
\nstring
The Google Chat domain ID.
modified_at [required]
\ndate-time
Timestamp when the configuration was last modified.
space_name_template [required]
\nstring
The template for the Google Chat space name.
space_target_audience_id [required]
\nstring
The target audience ID for the Google Chat space.
space_time_zone [required]
\nstring
The time zone for the Google Chat space.
id [required]
\nuuid
The configuration identifier.
relationships
\nobject
Relationships for a Google Chat configuration.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Google Chat configuration data in a create request.
attributes [required]
\nobject
Attributes for creating a Google Chat configuration.
domain_id [required]
\nstring
The Google Chat domain ID.
space_name_template [required]
\nstring
The template for the Google Chat space name.
space_target_audience_id [required]
\nstring
The target audience ID for the Google Chat space.
space_time_zone [required]
\nstring
The time zone for the Google Chat space.
relationships [required]
\nobject
Relationships for a Google Chat configuration create request.
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Google Chat configuration data in a response.
attributes [required]
\nobject
Attributes of a Google Chat configuration.
created_at [required]
\ndate-time
Timestamp when the configuration was created.
domain_id [required]
\nstring
The Google Chat domain ID.
modified_at [required]
\ndate-time
Timestamp when the configuration was last modified.
space_name_template [required]
\nstring
The template for the Google Chat space name.
space_target_audience_id [required]
\nstring
The target audience ID for the Google Chat space.
space_time_zone [required]
\nstring
The time zone for the Google Chat space.
id [required]
\nuuid
The configuration identifier.
relationships
\nobject
Relationships for a Google Chat configuration.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations
included
\n[object]
Included related resources.
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 [required]
\nobject
Notification rule data for a create request.
attributes [required]
\nobject
The attributes for creating a notification rule.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
enabled
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
relationships
\nobject
The definition of NotificationRuleCreateDataRelationships object.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
data [required]
\nobject
Google Chat configuration data in a patch request.
attributes
\nobject
Attributes for patching a Google Chat configuration. All fields are optional.
domain_id
\nstring
The Google Chat domain ID.
space_name_template
\nstring
The template for the Google Chat space name.
space_target_audience_id
\nstring
The target audience ID for the Google Chat space.
space_time_zone
\nstring
The time zone for the Google Chat space.
id [required]
\nuuid
The configuration identifier.
type [required]
\nenum
Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Google Meet configuration data in a response.
attributes [required]
\nobject
Attributes of a Google Meet configuration.
allow_manual_meeting_creation [required]
\nboolean
Whether manual meeting creation is allowed.
auto_summarize [required]
\nboolean
Whether meetings are auto-summarized.
created_at
\ndate-time
Timestamp when the configuration was created.
modified_at [required]
\ndate-time
Timestamp when the configuration was last modified.
id [required]
\nuuid
The configuration identifier.
relationships
\nobject
Relationships for a Google Meet configuration.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Google Meet configuration data in a create request.
attributes [required]
\nobject
Attributes for creating a Google Meet configuration.
allow_manual_meeting_creation [required]
\nboolean
Whether to allow manual meeting creation.
auto_summarize [required]
\nboolean
Whether to auto-summarize meetings.
relationships [required]
\nobject
Relationships for a Google Meet configuration create request.
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Google Meet configuration data in a response.
attributes [required]
\nobject
Attributes of a Google Meet configuration.
allow_manual_meeting_creation [required]
\nboolean
Whether manual meeting creation is allowed.
auto_summarize [required]
\nboolean
Whether meetings are auto-summarized.
created_at
\ndate-time
Timestamp when the configuration was created.
modified_at [required]
\ndate-time
Timestamp when the configuration was last modified.
id [required]
\nuuid
The configuration identifier.
relationships
\nobject
Relationships for a Google Meet configuration.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations
included
\n[object]
Included related resources.
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 [required]
\nobject
Google Meet configuration data in a patch request.
attributes
\nobject
Attributes for patching a Google Meet configuration. All fields are optional.
allow_manual_meeting_creation
\nboolean
Whether to allow manual meeting creation.
auto_summarize
\nboolean
Whether to auto-summarize meetings.
id [required]
\nuuid
The configuration identifier.
type [required]
\nenum
Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations
data [required]
\n[object]
List of impact fields.
attributes [required]
\nobject
Attributes of an impact field in a response.
display_name [required]
\nstring
The display name of the impact field.
field_choices
\n[object]
The choices for dropdown or multiselect fields.
description
\nstring
The description of the choice.
display_name [required]
\nstring
The display name of the choice.
value [required]
\nstring
The value of the choice.
field_type [required]
\nenum
The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect
name [required]
\nstring
The normalized name of the impact field.
tag_key
\nstring
The tag key associated with the field.
id [required]
\nuuid
The impact field identifier.
relationships
\nobject
Relationships for an impact field.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Impact field resource type. \nAllowed enum values: impact_fields
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Impact field data in a response.
attributes [required]
\nobject
Attributes of an impact field in a response.
display_name [required]
\nstring
The display name of the impact field.
field_choices
\n[object]
The choices for dropdown or multiselect fields.
description
\nstring
The description of the choice.
display_name [required]
\nstring
The display name of the choice.
value [required]
\nstring
The value of the choice.
field_type [required]
\nenum
The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect
name [required]
\nstring
The normalized name of the impact field.
tag_key
\nstring
The tag key associated with the field.
id [required]
\nuuid
The impact field identifier.
relationships
\nobject
Relationships for an impact field.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Impact field resource type. \nAllowed enum values: impact_fields
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Notification rule data for an update request.
attributes [required]
\nobject
The attributes for creating a notification rule.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
enabled
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The definition of NotificationRuleCreateDataRelationships object.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
data [required]
\nobject
Impact field data in a create request.
attributes [required]
\nobject
Attributes for creating an impact field.
display_name [required]
\nstring
The display name of the impact field.
field_choices
\n[object]
The choices for dropdown or multiselect fields.
description
\nstring
The description of the choice.
display_name [required]
\nstring
The display name of the choice.
value [required]
\nstring
The value of the choice.
field_type [required]
\nenum
The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect
name [required]
\nstring
The normalized name of the impact field (used as identifier).
tag_key
\nstring
The tag key associated with the field (for metrictag type).
relationships [required]
\nobject
Relationships for an impact field create request.
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Impact field resource type. \nAllowed enum values: impact_fields
data [required]
\n[object]
The NotificationTemplateArray data.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
meta
\nobject
Response metadata.
page
\nobject
Pagination metadata.
total_count
\nint64
Total number of notification templates.
total_filtered_count
\nint64
Total number of notification templates matching the filter.
data [required]
\nobject
Impact field data in a response.
attributes [required]
\nobject
Attributes of an impact field in a response.
display_name [required]
\nstring
The display name of the impact field.
field_choices
\n[object]
The choices for dropdown or multiselect fields.
description
\nstring
The description of the choice.
display_name [required]
\nstring
The display name of the choice.
value [required]
\nstring
The value of the choice.
field_type [required]
\nenum
The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect
name [required]
\nstring
The normalized name of the impact field.
tag_key
\nstring
The tag key associated with the field.
id [required]
\nuuid
The impact field identifier.
relationships
\nobject
Relationships for an impact field.
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
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Impact field resource type. \nAllowed enum values: impact_fields
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Impact field data in a create request.
attributes [required]
\nobject
Attributes for creating an impact field.
display_name [required]
\nstring
The display name of the impact field.
field_choices
\n[object]
The choices for dropdown or multiselect fields.
description
\nstring
The description of the choice.
display_name [required]
\nstring
The display name of the choice.
value [required]
\nstring
The value of the choice.
field_type [required]
\nenum
The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect
name [required]
\nstring
The normalized name of the impact field (used as identifier).
tag_key
\nstring
The tag key associated with the field (for metrictag type).
relationships [required]
\nobject
Relationships for an impact field create request.
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Impact field resource type. \nAllowed enum values: impact_fields
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\n[object]
The NotificationRuleArray data.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
meta
\nobject
Response metadata.
pagination
\nobject
Pagination metadata.
next_offset
\nint64
The offset for the next page of results.
offset
\nint64
The current offset in the results.
size
\nint64
The number of results returned per page.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Notification template data for a create request.
attributes [required]
\nobject
The attributes for creating a notification template.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
relationships
\nobject
The definition of NotificationTemplateCreateDataRelationships object.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Notification rule data for a create request.
attributes [required]
\nobject
The attributes for creating a notification rule.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
enabled
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
relationships
\nobject
The definition of NotificationRuleCreateDataRelationships object.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Notification template data for an update request.
attributes
\nobject
The attributes to update on a notification template.
category
\nstring
The category of the notification template.
content
\nstring
The content body of the notification template.
name
\nstring
The name of the notification template.
subject
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\n[object]
An array of postmortem template data objects.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for a postmortem template returned in a response.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for creating or updating a postmortem template.
attributes [required]
\nobject
Attributes for creating or updating a postmortem template.
name [required]
\nstring
The name of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
data [required]
\nobject
Notification rule data for an update request.
attributes [required]
\nobject
The attributes for creating a notification rule.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
enabled
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The definition of NotificationRuleCreateDataRelationships object.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\n[object]
The NotificationTemplateArray data.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
meta
\nobject
Response metadata.
page
\nobject
Pagination metadata.
total_count
\nint64
Total number of notification templates.
total_filtered_count
\nint64
Total number of notification templates matching the filter.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for a postmortem template returned in a response.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for a postmortem template returned in a response.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for creating or updating a postmortem template.
attributes [required]
\nobject
Attributes for creating or updating a postmortem template.
name [required]
\nstring
The name of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
data [required]
\nobject
Notification template data for a create request.
attributes [required]
\nobject
The attributes for creating a notification template.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
relationships
\nobject
The definition of NotificationTemplateCreateDataRelationships object.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\n[object]
An array of incident type objects.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Incident type data for a create request.
attributes [required]
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
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
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data for an update request.
attributes
\nobject
The attributes to update on a notification template.
category
\nstring
The category of the notification template.
content
\nstring
The content body of the notification template.
name
\nstring
The name of the notification template.
subject
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\n[object]
An array of postmortem template data objects.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for a postmortem template returned in a response.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\nobject
Incident type data for a patch request.
attributes [required]
\nobject
Incident type's attributes for updates.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
When true, this incident type will be used as the default type when an incident type is not specified.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Data object for creating or updating a postmortem template.
attributes [required]
\nobject
Attributes for creating or updating a postmortem template.
name [required]
\nstring
The name of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
data [required]
\n[object]
An array of user-defined field objects.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
meta [required]
\nobject
Pagination metadata for the user-defined field list response.
offset
\nint64
The offset of the current page.
size
\nint64
The total number of items in the current page.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for a postmortem template returned in a response.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\nobject
Data object for an incident user-defined field response.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
data [required]
\nobject
Data object for a postmortem template returned in a response.
attributes [required]
\nobject
Attributes of a postmortem template returned in a response.
createdAt [required]
\ndate-time
When the template was created
modifiedAt [required]
\ndate-time
When the template was last modified
name [required]
\nstring
The name of the template
id [required]
\nstring
The ID of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for creating an incident user-defined field.
attributes [required]
\nobject
Attributes for creating an incident user-defined field.
category
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
default_value
\nstring
The default value for the field. Must be one of the valid values when valid_values is set.
display_name
\nstring
The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
name [required]
\nstring
The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.
ordinal
\nstring
A decimal string representing the field's display order in the UI.
required
\nboolean
When true, users must fill out this field on incidents.
tag_key
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nenum
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime. \nAllowed enum values: 1,2,3,4,5,6,7,8
valid_values
\n[object]
The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
relationships [required]
\nobject
Relationships for creating an incident user-defined field.
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
data [required]
\nobject
Data object for creating or updating a postmortem template.
attributes [required]
\nobject
Attributes for creating or updating a postmortem template.
name [required]
\nstring
The name of the template
type [required]
\nenum
Postmortem template resource type \nAllowed enum values: postmortem_template
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\n[object]
List of incident rules.
attributes [required]
\nobject
Attributes of an incident rule in a response.
condition
\nobject
A query-based condition for an incident rule.
normalized_query
\nstring
The normalized query string.
raw_query
\nstring
The raw query string.
condition_table_type
\ninteger
The condition table type.
conditions
\n[object]
List of field-based conditions.
field [required]
\nstring
The field to match on.
values [required]
\n[string]
The values to match.
created
\ndate-time
Timestamp when the rule was created.
created_by_uuid
\nuuid
UUID of the user who created the rule.
deleted
\ndate-time
Timestamp when the rule was deleted.
enabled
\nboolean
Whether the rule is enabled.
execution_type
\ninteger
The execution type of the rule.
incident_settings_association_uuid
\nuuid
The incident settings association UUID.
match_any_condition
\nboolean
Whether any condition should match.
modified
\ndate-time
Timestamp when the rule was last modified.
modified_by_uuid
\nuuid
UUID of the user who last modified the rule.
org_id
\nint64
The organization ID.
task_id
\nstring
The task ID.
task_payload
\nstring
The JSON-encoded task payload.
trigger
\nstring
The trigger event for the rule.
id [required]
\nuuid
The rule identifier.
type [required]
\nenum
Incident rule response resource type. \nAllowed enum values: incidents_rules
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for an incident user-defined field response.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
data [required]
\nobject
Incident rule data in a response.
attributes [required]
\nobject
Attributes of an incident rule in a response.
condition
\nobject
A query-based condition for an incident rule.
normalized_query
\nstring
The normalized query string.
raw_query
\nstring
The raw query string.
condition_table_type
\ninteger
The condition table type.
conditions
\n[object]
List of field-based conditions.
field [required]
\nstring
The field to match on.
values [required]
\n[string]
The values to match.
created
\ndate-time
Timestamp when the rule was created.
created_by_uuid
\nuuid
UUID of the user who created the rule.
deleted
\ndate-time
Timestamp when the rule was deleted.
enabled
\nboolean
Whether the rule is enabled.
execution_type
\ninteger
The execution type of the rule.
incident_settings_association_uuid
\nuuid
The incident settings association UUID.
match_any_condition
\nboolean
Whether any condition should match.
modified
\ndate-time
Timestamp when the rule was last modified.
modified_by_uuid
\nuuid
UUID of the user who last modified the rule.
org_id
\nint64
The organization ID.
task_id
\nstring
The task ID.
task_payload
\nstring
The JSON-encoded task payload.
trigger
\nstring
The trigger event for the rule.
id [required]
\nuuid
The rule identifier.
type [required]
\nenum
Incident rule response resource type. \nAllowed enum values: incidents_rules
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident rule data in a create request.
attributes [required]
\nobject
Attributes for creating an incident rule.
condition [required]
\nobject
A query-based condition for an incident rule.
normalized_query
\nstring
The normalized query string.
raw_query
\nstring
The raw query string.
condition_table_type [required]
\ninteger
The condition table type. 1 = raw query.
conditions
\n[object]
List of field-based conditions.
field [required]
\nstring
The field to match on.
values [required]
\n[string]
The values to match.
enabled [required]
\nboolean
Whether the rule is enabled.
execution_type [required]
\nenum
The execution type of an incident rule. \nAllowed enum values: 1,2
incident_type_uuid
\nuuid
The UUID of the incident type this rule applies to.
match_any_condition
\nboolean
Whether any condition (OR logic) should match instead of all (AND logic).
task_id [required]
\nenum
The task ID for an incident rule. \nAllowed enum values: jira-create-issue-job,notify-incident-handles-job,servicenow-create-incident-job,slack-create-channel-job,zoom-create-meeting-job,google-meet-create-meeting-job,workflow-automation-job,ms-teams-create-meeting-job,google-chat-create-space-job,zoom-suppress-summarization-jobShow 2 more
,ms-teams-suppress-summarization-job,google-meet-suppress-summarization-job
task_payload [required]
\nstring
The JSON-encoded payload for the task.
trigger
\nenum
The trigger event for an incident rule. \nAllowed enum values: incident_saved_trigger,incident_created_trigger,incident_modified_trigger
type [required]
\nenum
Incident rule resource type. \nAllowed enum values: incident_rules
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident rule data in a response.
attributes [required]
\nobject
Attributes of an incident rule in a response.
condition
\nobject
A query-based condition for an incident rule.
normalized_query
\nstring
The normalized query string.
raw_query
\nstring
The raw query string.
condition_table_type
\ninteger
The condition table type.
conditions
\n[object]
List of field-based conditions.
field [required]
\nstring
The field to match on.
values [required]
\n[string]
The values to match.
created
\ndate-time
Timestamp when the rule was created.
created_by_uuid
\nuuid
UUID of the user who created the rule.
deleted
\ndate-time
Timestamp when the rule was deleted.
enabled
\nboolean
Whether the rule is enabled.
execution_type
\ninteger
The execution type of the rule.
incident_settings_association_uuid
\nuuid
The incident settings association UUID.
match_any_condition
\nboolean
Whether any condition should match.
modified
\ndate-time
Timestamp when the rule was last modified.
modified_by_uuid
\nuuid
UUID of the user who last modified the rule.
org_id
\nint64
The organization ID.
task_id
\nstring
The task ID.
task_payload
\nstring
The JSON-encoded task payload.
trigger
\nstring
The trigger event for the rule.
id [required]
\nuuid
The rule identifier.
type [required]
\nenum
Incident rule response resource type. \nAllowed enum values: incidents_rules
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for an incident user-defined field response.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
data [required]
\nobject
Incident rule data in a response.
attributes [required]
\nobject
Attributes of an incident rule in a response.
condition
\nobject
A query-based condition for an incident rule.
normalized_query
\nstring
The normalized query string.
raw_query
\nstring
The raw query string.
condition_table_type
\ninteger
The condition table type.
conditions
\n[object]
List of field-based conditions.
field [required]
\nstring
The field to match on.
values [required]
\n[string]
The values to match.
created
\ndate-time
Timestamp when the rule was created.
created_by_uuid
\nuuid
UUID of the user who created the rule.
deleted
\ndate-time
Timestamp when the rule was deleted.
enabled
\nboolean
Whether the rule is enabled.
execution_type
\ninteger
The execution type of the rule.
incident_settings_association_uuid
\nuuid
The incident settings association UUID.
match_any_condition
\nboolean
Whether any condition should match.
modified
\ndate-time
Timestamp when the rule was last modified.
modified_by_uuid
\nuuid
UUID of the user who last modified the rule.
org_id
\nint64
The organization ID.
task_id
\nstring
The task ID.
task_payload
\nstring
The JSON-encoded task payload.
trigger
\nstring
The trigger event for the rule.
id [required]
\nuuid
The rule identifier.
type [required]
\nenum
Incident rule response resource type. \nAllowed enum values: incidents_rules
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for updating an incident user-defined field.
attributes [required]
\nobject
Attributes for updating an incident user-defined field. All fields are optional.
category
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
default_value
\nstring
The default value for the field. Must be one of the valid values when valid_values is set.
display_name
\nstring
The human-readable name shown in the UI.
ordinal
\nstring
A decimal string representing the field's display order in the UI.
required
\nboolean
When true, users must fill out this field on incidents.
valid_values
\n[object]
The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field to update.
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
data [required]
\nobject
Incident rule data in a patch request.
attributes
\nobject
Attributes for patching an incident rule. All fields are optional.
condition
\nobject
A query-based condition for an incident rule.
normalized_query
\nstring
The normalized query string.
raw_query
\nstring
The raw query string.
conditions
\n[object]
List of field-based conditions.
field [required]
\nstring
The field to match on.
values [required]
\n[string]
The values to match.
enabled
\nboolean
Whether the rule is enabled.
task_payload
\nstring
The JSON-encoded payload for the task.
trigger
\nenum
The trigger event for an incident rule. \nAllowed enum values: incident_saved_trigger,incident_created_trigger,incident_modified_trigger
id [required]
\nuuid
The rule identifier.
type [required]
\nenum
Incident rule resource type. \nAllowed enum values: incident_rules
data [required]
\n[object]
An array of incident type objects.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data from an import response.
attributes
\nobject
The incident's attributes from an import response.
archived
\ndate-time
Timestamp when the incident was archived.
case_id
\nint64
The incident case ID.
created
\ndate-time
Timestamp when the incident was created.
created_by_uuid
\nstring
UUID of the user who created the incident.
creation_idempotency_key
\nstring
A unique key used to ensure idempotent incident creation.
customer_impact_end
\ndate-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
\nstring
A summary of the impact customers experienced during the incident.
customer_impact_start
\ndate-time
Timestamp when customers began to be impacted by the incident.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by_uuid
\nstring
UUID of the user who declared the incident.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields attached to incidents.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
type
\nenum
Type of the single value field definitions. \nAllowed enum values: dropdown,textbox
default: dropdown
value
\nstring
The single value selected for this field.
Option 2
\nobject
A field with potentially multiple values selected.
type
\nenum
Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
\n[string]
The multiple values selected for this field.
incident_type_uuid
\nstring
A unique identifier that represents an incident type.
is_test
\nboolean
A flag indicating whether the incident is a test incident.
last_modified_by_uuid
\nstring
UUID of the user who last modified the incident.
modified
\ndate-time
Timestamp when the incident was last modified.
non_datadog_creator
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
notification_handles
\n[object]
Notification handles that are notified of the incident during update.
display_name
\nstring
The name of the notified handle.
handle
\nstring
The handle used for the notification. This includes an email address, Slack channel, or workflow.
public_id
\nint64
The monotonically increasing integer ID for the incident.
resolved
\ndate-time
Timestamp when the incident's state was last changed from active or stable to resolved or completed.
severity
\nenum
The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5
state
\nstring
The state of the incident.
title [required]
\nstring
The title of the incident that summarizes what happened.
visibility
\nstring
The incident visibility status.
id [required]
\nstring
The incident's ID.
relationships
\nobject
The incident's relationships from an import response.
attachments
\nobject
A relationship reference for attachments.
data [required]
\n[object]
An array of incident attachments.
id [required]
\nstring
A unique identifier that represents the attachment.
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
declared_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
impacts
\nobject
Relationship to impacts.
data [required]
\n[object]
An array of incident impacts.
id [required]
\nstring
A unique identifier that represents the impact.
type [required]
\nenum
The incident impacts type. \nAllowed enum values: incident_impacts
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
integrations
\nobject
A relationship reference for multiple integration metadata objects.
data [required]
\n[object]
Integration metadata relationship array
id [required]
\nstring
A unique identifier that represents the integration metadata.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
responders
\nobject
Relationship to incident responders.
data [required]
\n[object]
An array of incident responders.
id [required]
\nstring
A unique identifier that represents the responder.
type [required]
\nenum
The incident responders type. \nAllowed enum values: incident_responders
user_defined_fields
\nobject
Relationship to incident user defined fields.
data [required]
\n[object]
An array of user defined fields.
id [required]
\nstring
A unique identifier that represents the responder.
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Incident type data for a create request.
attributes [required]
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\n[object]
List of incident org settings resources.
attributes [required]
\nobject
Attributes of an incident org settings resource in a response.
created [required]
\ndate-time
Timestamp when the settings were created.
modified [required]
\ndate-time
Timestamp when the settings were last modified.
settings [required]
\nobject
The settings configuration for an incident org settings resource.
id [required]
\nuuid
The org settings identifier.
relationships
\nobject
Relationships for an incident org settings resource.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Incident org settings resource type. \nAllowed enum values: incident_org_settings
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident type data for a patch request.
attributes [required]
\nobject
Incident type's attributes for updates.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
When true, this incident type will be used as the default type when an incident type is not specified.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Incident org settings data in a response.
attributes [required]
\nobject
Attributes of an incident org settings resource in a response.
created [required]
\ndate-time
Timestamp when the settings were created.
modified [required]
\ndate-time
Timestamp when the settings were last modified.
settings [required]
\nobject
The settings configuration for an incident org settings resource.
id [required]
\nuuid
The org settings identifier.
relationships
\nobject
Relationships for an incident org settings resource.
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
Incident org settings resource type. \nAllowed enum values: incident_org_settings
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\n[object]
An array of user-defined field objects.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
meta [required]
\nobject
Pagination metadata for the user-defined field list response.
offset
\nint64
The offset of the current page.
size
\nint64
The total number of items in the current page.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for an incident user-defined field response.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for creating an incident user-defined field.
attributes [required]
\nobject
Attributes for creating an incident user-defined field.
category
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
default_value
\nstring
The default value for the field. Must be one of the valid values when valid_values is set.
display_name
\nstring
The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
name [required]
\nstring
The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.
ordinal
\nstring
A decimal string representing the field's display order in the UI.
required
\nboolean
When true, users must fill out this field on incidents.
tag_key
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nenum
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime. \nAllowed enum values: 1,2,3,4,5,6,7,8
valid_values
\n[object]
The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
relationships [required]
\nobject
Relationships for creating an incident user-defined field.
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for an incident user-defined field response.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for an incident user-defined field response.
attributes [required]
\nobject
Attributes of an incident user-defined field.
attached_to [required]
\nstring
The resource type this field is attached to. Always "incidents".
category [required]
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected [required]
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
created [required]
\ndate-time
Timestamp when the field was created.
default_value [required]
\nstring
The default value for the field.
deleted [required]
\ndate-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
\nstring
The human-readable name shown in the UI.
metadata [required]
\nobject
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
\nstring
The category of the autocomplete source.
search_limit_param [required]
\nstring
The query parameter used to limit the number of autocomplete results.
search_params [required]
\nobject
Additional query parameters to include in the search URL.
search_query_param [required]
\nstring
The query parameter used to pass typed input to the search URL.
search_result_path [required]
\nstring
The JSON path to the results in the response body.
search_url [required]
\nstring
The URL used to populate autocomplete options.
modified [required]
\ndate-time
Timestamp when the field was last modified.
name [required]
\nstring
The unique identifier of the field.
ordinal [required]
\nstring
A decimal string representing the field's display order in the UI.
prerequisite [required]
\nstring
Reserved for future use. Always null.
required [required]
\nboolean
When true, users must fill out this field on incidents.
reserved [required]
\nboolean
When true, this field is reserved for system use and cannot be deleted.
table_id [required]
\nint64
Reserved for internal use. Always 0.
tag_key [required]
\nstring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
\nint32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
\n[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field.
relationships [required]
\nobject
Relationships of an incident user-defined field.
created_by_user [required]
\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
incident_type [required]
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
\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 user defined fields type. \nAllowed enum values: user_defined_field
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for updating an incident user-defined field.
attributes [required]
\nobject
Attributes for updating an incident user-defined field. All fields are optional.
category
\nenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section. \nAllowed enum values: what_happened,why_it_happened
collected
\nenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields. \nAllowed enum values: active,stable,resolved,completed
default_value
\nstring
The default value for the field. Must be one of the valid values when valid_values is set.
display_name
\nstring
The human-readable name shown in the UI.
ordinal
\nstring
A decimal string representing the field's display order in the UI.
required
\nboolean
When true, users must fill out this field on incidents.
valid_values
\n[object]
The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
description
\nstring
A detailed description of the valid value.
display_name [required]
\nstring
The human-readable display name for this value.
short_description
\nstring
A short description of the valid value.
value [required]
\nstring
The identifier that is stored when this option is selected.
id [required]
\nstring
The unique identifier of the user-defined field to update.
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
data [required]
\n[object]
List of incident user-defined role data objects.
attributes [required]
\nobject
Attributes of an incident user-defined role.
created [required]
\ndate-time
Timestamp when the role was created.
description
\nstring
A description of the user-defined role.
modified [required]
\ndate-time
Timestamp when the role was last modified.
name [required]
\nstring
The name of the user-defined role.
policy [required]
\nobject
Policy configuration for a user-defined role.
is_single [required]
\nboolean
Whether this role can only be assigned to one responder at a time.
id [required]
\nuuid
The ID of the user-defined role.
relationships
\nobject
Relationships of a user-defined role response.
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
incident_type
\nobject
Relationship to an incident type for a user-defined role.
data [required]
\nobject
Data for the incident type relationship of a user-defined role.
id [required]
\nuuid
The ID of the incident type.
type [required]
\nstring
The type of the resource.
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
Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles
included
\n[ <oneOf>]
Included resources for an incident user-defined role response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for an incident user-defined role response.
attributes [required]
\nobject
Attributes of an incident user-defined role.
created [required]
\ndate-time
Timestamp when the role was created.
description
\nstring
A description of the user-defined role.
modified [required]
\ndate-time
Timestamp when the role was last modified.
name [required]
\nstring
The name of the user-defined role.
policy [required]
\nobject
Policy configuration for a user-defined role.
is_single [required]
\nboolean
Whether this role can only be assigned to one responder at a time.
id [required]
\nuuid
The ID of the user-defined role.
relationships
\nobject
Relationships of a user-defined role response.
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
incident_type
\nobject
Relationship to an incident type for a user-defined role.
data [required]
\nobject
Data for the incident type relationship of a user-defined role.
id [required]
\nuuid
The ID of the incident type.
type [required]
\nstring
The type of the resource.
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
Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles
included
\n[ <oneOf>]
Included resources for an incident user-defined role response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for creating an incident user-defined role.
attributes [required]
\nobject
Attributes for creating an incident user-defined role.
description
\nstring
A description of the user-defined role.
name [required]
\nstring
The name of the user-defined role.
policy [required]
\nobject
Policy configuration for a user-defined role.
is_single [required]
\nboolean
Whether this role can only be assigned to one responder at a time.
relationships [required]
\nobject
Relationships for creating a user-defined role.
incident_type [required]
\nobject
Relationship to an incident type for a user-defined role.
data [required]
\nobject
Data for the incident type relationship of a user-defined role.
id [required]
\nuuid
The ID of the incident type.
type [required]
\nstring
The type of the resource.
type [required]
\nenum
Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for an incident user-defined role response.
attributes [required]
\nobject
Attributes of an incident user-defined role.
created [required]
\ndate-time
Timestamp when the role was created.
description
\nstring
A description of the user-defined role.
modified [required]
\ndate-time
Timestamp when the role was last modified.
name [required]
\nstring
The name of the user-defined role.
policy [required]
\nobject
Policy configuration for a user-defined role.
is_single [required]
\nboolean
Whether this role can only be assigned to one responder at a time.
id [required]
\nuuid
The ID of the user-defined role.
relationships
\nobject
Relationships of a user-defined role response.
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
incident_type
\nobject
Relationship to an incident type for a user-defined role.
data [required]
\nobject
Data for the incident type relationship of a user-defined role.
id [required]
\nuuid
The ID of the incident type.
type [required]
\nstring
The type of the resource.
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
Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles
included
\n[ <oneOf>]
Included resources for an incident user-defined role response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for an incident user-defined role response.
attributes [required]
\nobject
Attributes of an incident user-defined role.
created [required]
\ndate-time
Timestamp when the role was created.
description
\nstring
A description of the user-defined role.
modified [required]
\ndate-time
Timestamp when the role was last modified.
name [required]
\nstring
The name of the user-defined role.
policy [required]
\nobject
Policy configuration for a user-defined role.
is_single [required]
\nboolean
Whether this role can only be assigned to one responder at a time.
id [required]
\nuuid
The ID of the user-defined role.
relationships
\nobject
Relationships of a user-defined role response.
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
incident_type
\nobject
Relationship to an incident type for a user-defined role.
data [required]
\nobject
Data for the incident type relationship of a user-defined role.
id [required]
\nuuid
The ID of the incident type.
type [required]
\nstring
The type of the resource.
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
Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles
included
\n[ <oneOf>]
Included resources for an incident user-defined role response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data for updating an incident user-defined role.
attributes
\nobject
Attributes for updating an incident user-defined role.
description
\nstring
A description of the user-defined role.
name
\nstring
The name of the user-defined role.
policy
\nobject
Policy configuration for a user-defined role.
is_single [required]
\nboolean
Whether this role can only be assigned to one responder at a time.
id [required]
\nuuid
The ID of the user-defined role to update.
type [required]
\nenum
Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles
data [required]
\nobject
Incident data from an import response.
attributes
\nobject
The incident's attributes from an import response.
archived
\ndate-time
Timestamp when the incident was archived.
case_id
\nint64
The incident case ID.
created
\ndate-time
Timestamp when the incident was created.
created_by_uuid
\nstring
UUID of the user who created the incident.
creation_idempotency_key
\nstring
A unique key used to ensure idempotent incident creation.
customer_impact_end
\ndate-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
\nstring
A summary of the impact customers experienced during the incident.
customer_impact_start
\ndate-time
Timestamp when customers began to be impacted by the incident.
declared
\ndate-time
Timestamp when the incident was declared.
declared_by_uuid
\nstring
UUID of the user who declared the incident.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields attached to incidents.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
type
\nenum
Type of the single value field definitions. \nAllowed enum values: dropdown,textbox
default: dropdown
value
\nstring
The single value selected for this field.
Option 2
\nobject
A field with potentially multiple values selected.
type
\nenum
Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
\n[string]
The multiple values selected for this field.
incident_type_uuid
\nstring
A unique identifier that represents an incident type.
is_test
\nboolean
A flag indicating whether the incident is a test incident.
last_modified_by_uuid
\nstring
UUID of the user who last modified the incident.
modified
\ndate-time
Timestamp when the incident was last modified.
non_datadog_creator
\nobject
Incident's non Datadog creator.
image_48_px
\nstring
Non Datadog creator 48px image.
name
\nstring
Non Datadog creator name.
notification_handles
\n[object]
Notification handles that are notified of the incident during update.
display_name
\nstring
The name of the notified handle.
handle
\nstring
The handle used for the notification. This includes an email address, Slack channel, or workflow.
public_id
\nint64
The monotonically increasing integer ID for the incident.
resolved
\ndate-time
Timestamp when the incident's state was last changed from active or stable to resolved or completed.
severity
\nenum
The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5
state
\nstring
The state of the incident.
title [required]
\nstring
The title of the incident that summarizes what happened.
visibility
\nstring
The incident visibility status.
id [required]
\nstring
The incident's ID.
relationships
\nobject
The incident's relationships from an import response.
attachments
\nobject
A relationship reference for attachments.
data [required]
\n[object]
An array of incident attachments.
id [required]
\nstring
A unique identifier that represents the attachment.
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
declared_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
impacts
\nobject
Relationship to impacts.
data [required]
\n[object]
An array of incident impacts.
id [required]
\nstring
A unique identifier that represents the impact.
type [required]
\nenum
The incident impacts type. \nAllowed enum values: incident_impacts
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
integrations
\nobject
A relationship reference for multiple integration metadata objects.
data [required]
\n[object]
Integration metadata relationship array
id [required]
\nstring
A unique identifier that represents the integration metadata.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
responders
\nobject
Relationship to incident responders.
data [required]
\n[object]
An array of incident responders.
id [required]
\nstring
A unique identifier that represents the responder.
type [required]
\nenum
The incident responders type. \nAllowed enum values: incident_responders
user_defined_fields
\nobject
Relationship to incident user defined fields.
data [required]
\n[object]
An array of user defined fields.
id [required]
\nstring
A unique identifier that represents the responder.
type [required]
\nenum
The incident user defined fields type. \nAllowed enum values: user_defined_field
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
name
\nstring
Name of the user.
uuid
\nstring
UUID of the user.
id
\nstring
ID of the user.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data for an import request.
attributes [required]
\nobject
The incident's attributes for an import request.
declared
\ndate-time
Timestamp when the incident was declared.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields for which to create initial selections.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
value
\nstring
The single value selected for this field.
Option 2
\nobject
A field with potentially multiple values selected.
value
\n[string]
The multiple values selected for this field.
incident_type_uuid
\nstring
A unique identifier that represents the incident type. If not provided, the default incident type is used.
resolved
\ndate-time
Timestamp when the incident was resolved. Can only be set when the state field is set to 'resolved'.
title [required]
\nstring
The title of the incident that summarizes what happened.
visibility
\nenum
The visibility of the incident. \nAllowed enum values: organization,private
default: organization
relationships
\nobject
The relationships for an incident import request.
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
declared_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
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.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data 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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data 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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data for an update request.
attributes
\nobject
The incident's attributes for an update request.
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.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields for which to update selections.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
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.
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.
title
\nstring
The title of the incident, which summarizes what happened.
id [required]
\nstring
The incident's ID.
relationships
\nobject
The incident's relationships for an update request.
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
postmortem
\nobject
A relationship reference for postmortems.
data [required]
\nobject
The postmortem relationship data.
id [required]
\nstring
A unique identifier that represents the postmortem.
type [required]
\nenum
Incident postmortem resource type. \nAllowed enum values: incident_postmortems
default: incident_postmortems
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
data [required]
\nobject
AI postmortem data in a response.
attributes [required]
\nobject
Attributes of an AI-generated incident postmortem.
action_items
\nstring
Action items to prevent recurrence.
customer_impact
\nstring
The impact of the incident on customers.
executive_summary
\nstring
An executive summary of the incident.
key_insights
\nstring
Key insights from the incident.
key_timeline
\nstring
Key timeline events during the incident.
lessons_learned
\nstring
Lessons learned from the incident.
system_overview
\nstring
An overview of the affected systems.
id [required]
\nuuid
The incident identifier.
type [required]
\nenum
AI postmortem response resource type. \nAllowed enum values: get_incident_ai_postmortem_response
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\n[object]
An array of attachment data objects.
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>]
A list of related objects included in the response.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
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>]
A list of related objects included in the response.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data
\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
The unique identifier of the attachment.
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
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>]
A list of related objects included in the response.
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
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Postmortem attachment data
attributes [required]
\nobject
Postmortem attachment attributes
cells
\n[object]
The cells of the postmortem
attributes
\nobject
Attributes of a postmortem cell
definition
\nobject
Definition of a postmortem cell
content
\nstring
The content of the cell in markdown format
id
\nstring
The unique identifier of the cell
type
\nenum
The postmortem cell resource type. \nAllowed enum values: markdown
content
\nstring
The content of the postmortem
postmortem_template_id
\nstring
The ID of the postmortem template
title
\nstring
The title of the postmortem
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data
\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>]
A list of related objects included in the response.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data
\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
data [required]
\nobject
Page UUID data in a response.
id [required]
\nuuid
The UUID of the created page.
type [required]
\nenum
Resource type for a page UUID response. \nAllowed enum values: page_uuid
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Page data in a create request.
attributes [required]
\nobject
Attributes for creating a page from an incident.
description
\nstring
The description of the page.
incident_public_id
\nstring
The public ID of the incident.
role
\nobject
A reference to an incident role for a page.
id [required]
\nuuid
The role identifier.
type [required]
\nenum
The type of incident role for a page. \nAllowed enum values: incident_user_defined_roles,incident_reserved_roles
services
\n[string]
List of affected services.
tags
\n[string]
List of tags for the page.
target
\nobject
The target recipient for a page.
identifier [required]
\nstring
The identifier of the target (handle, UUID, or user UUID).
type [required]
\nenum
The type of target for a page request. \nAllowed enum values: team_handle,team_uuid,user_uuid
title
\nstring
The title of the page.
type [required]
\nenum
Resource type for a page creation request. \nAllowed enum values: page
data [required]
\nobject
Incident configuration data in a response.
attributes [required]
\nobject
Attributes of an incident configuration in a response.
created_at [required]
\ndate-time
Timestamp when the configuration was created.
execute_integrations
\nboolean
Whether integrations are executed for this incident.
execute_notification_rules
\nboolean
Whether notification rules are executed for this incident.
incident_id [required]
\nstring
The incident identifier.
include_in_analytics
\nboolean
Whether this incident is included in analytics.
include_in_search
\nboolean
Whether this incident is included in search results.
modified_at [required]
\ndate-time
Timestamp when the configuration was last modified.
id [required]
\nuuid
The incident configuration identifier.
relationships
\nobject
Relationships for an incident configuration.
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
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
Incident configuration resource type. \nAllowed enum values: incidents_configurations
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident configuration data in a patch request.
attributes
\nobject
Attributes for patching an incident configuration. All fields are optional.
execute_integrations
\nboolean
Whether to execute integrations for this incident.
execute_notification_rules
\nboolean
Whether to execute notification rules for this incident.
include_in_analytics
\nboolean
Whether to include this incident in analytics.
include_in_search
\nboolean
Whether to include this incident in search results.
id [required]
\nuuid
The incident configuration identifier.
type [required]
\nenum
Incident configuration resource type. \nAllowed enum values: incidents_configurations
data [required]
\nobject
Incident configuration data in a response.
attributes [required]
\nobject
Attributes of an incident configuration in a response.
created_at [required]
\ndate-time
Timestamp when the configuration was created.
execute_integrations
\nboolean
Whether integrations are executed for this incident.
execute_notification_rules
\nboolean
Whether notification rules are executed for this incident.
incident_id [required]
\nstring
The incident identifier.
include_in_analytics
\nboolean
Whether this incident is included in analytics.
include_in_search
\nboolean
Whether this incident is included in search results.
modified_at [required]
\ndate-time
Timestamp when the configuration was last modified.
id [required]
\nuuid
The incident configuration identifier.
relationships
\nobject
Relationships for an incident configuration.
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
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
Incident configuration resource type. \nAllowed enum values: incidents_configurations
included
\n[object]
Included related resources.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident configuration data in a create request.
attributes
\nobject
Attributes for creating an incident configuration.
execute_integrations
\nboolean
Whether to execute integrations for this incident.
execute_notification_rules
\nboolean
Whether to execute notification rules for this incident.
include_in_analytics
\nboolean
Whether to include this incident in analytics.
include_in_search
\nboolean
Whether to include this incident in search results.
type [required]
\nenum
Incident configuration resource type. \nAllowed enum values: incidents_configurations
data [required]
\n[object]
An array of incident impacts.
attributes
\nobject
The incident impact's attributes.
created
\ndate-time
Timestamp when the impact was created.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
impact_type
\nstring
The type of impact.
modified
\ndate-time
Timestamp when the impact was last modified.
start_at [required]
\ndate-time
Timestamp representing when the impact started.
id [required]
\nstring
The incident impact's ID.
relationships
\nobject
The incident impact's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
included
\n[object]
Included related resources that the user requested.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident impact data from a response.
attributes
\nobject
The incident impact's attributes.
created
\ndate-time
Timestamp when the impact was created.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
impact_type
\nstring
The type of impact.
modified
\ndate-time
Timestamp when the impact was last modified.
start_at [required]
\ndate-time
Timestamp representing when the impact started.
id [required]
\nstring
The incident impact's ID.
relationships
\nobject
The incident impact's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
included
\n[object]
Included related resources that the user requested.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident data for an import request.
attributes [required]
\nobject
The incident's attributes for an import request.
declared
\ndate-time
Timestamp when the incident was declared.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields for which to create initial selections.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
value
\nstring
The single value selected for this field.
Option 2
\nobject
A field with potentially multiple values selected.
value
\n[string]
The multiple values selected for this field.
incident_type_uuid
\nstring
A unique identifier that represents the incident type. If not provided, the default incident type is used.
resolved
\ndate-time
Timestamp when the incident was resolved. Can only be set when the state field is set to 'resolved'.
title [required]
\nstring
The title of the incident that summarizes what happened.
visibility
\nenum
The visibility of the incident. \nAllowed enum values: organization,private
default: organization
relationships
\nobject
The relationships for an incident import request.
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
declared_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
data [required]
\nobject
Incident impact data for a create request.
attributes [required]
\nobject
The incident impact's attributes for a create request.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
start_at [required]
\ndate-time
Timestamp when the impact started.
type [required]
\nenum
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident impact data from a response.
attributes
\nobject
The incident impact's attributes.
created
\ndate-time
Timestamp when the impact was created.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
impact_type
\nstring
The type of impact.
modified
\ndate-time
Timestamp when the impact was last modified.
start_at [required]
\ndate-time
Timestamp representing when the impact started.
id [required]
\nstring
The incident impact's ID.
relationships
\nobject
The incident impact's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
included
\n[object]
Included related resources that the user requested.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident impact data for a create request.
attributes [required]
\nobject
The incident impact's attributes for a create request.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
start_at [required]
\ndate-time
Timestamp when the impact started.
type [required]
\nenum
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
data [required]
\nobject
Incident impact data from a response.
attributes
\nobject
The incident impact's attributes.
created
\ndate-time
Timestamp when the impact was created.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
impact_type
\nstring
The type of impact.
modified
\ndate-time
Timestamp when the impact was last modified.
start_at [required]
\ndate-time
Timestamp representing when the impact started.
id [required]
\nstring
The incident impact's ID.
relationships
\nobject
The incident impact's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
included
\n[object]
Included related resources that the user requested.
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
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident impact data for a create request.
attributes [required]
\nobject
The incident impact's attributes for a create request.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
start_at [required]
\ndate-time
Timestamp when the impact started.
type [required]
\nenum
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
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
Page UUID data in a response.
id [required]
\nuuid
The UUID of the created page.
type [required]
\nenum
Resource type for a page UUID response. \nAllowed enum values: page_uuid
data [required]
\nobject
On-call page data in a create request.
attributes [required]
\nobject
Attributes for creating an on-call page from an incident.
description
\nstring
The description of the page.
role
\nobject
A reference to an incident role for a page.
id [required]
\nuuid
The role identifier.
type [required]
\nenum
The type of incident role for a page. \nAllowed enum values: incident_user_defined_roles,incident_reserved_roles
services
\n[string]
List of affected services.
tags
\n[string]
List of tags for the page.
target
\nobject
The target recipient for a page.
identifier [required]
\nstring
The identifier of the target (handle, UUID, or user UUID).
type [required]
\nenum
The type of target for a page request. \nAllowed enum values: team_handle,team_uuid,user_uuid
title
\nstring
The title of the page.
type [required]
\nenum
Resource type for a page creation request. \nAllowed enum values: page
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\nobject
On-call page data in a link request.
attributes
\nobject
Attributes for linking a page to an incident.
key
\nstring
The key of the on-call page.
page_target
\nobject
The target of an on-call page.
identifier [required]
\nstring
The identifier of the page target.
type [required]
\nstring
The type of the page target.
team_id
\nstring
The team ID associated with the page (deprecated, use page_target instead).
id [required]
\nstring
The ID of the on-call page to link.
type [required]
\nenum
On-call page resource type. \nAllowed enum values: page
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]
An array of incident integration metadata.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
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 integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident data for an update request.
attributes
\nobject
The incident's attributes for an update request.
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.
detected
\ndate-time
Timestamp when the incident was detected.
fields
\nobject
A condensed view of the user-defined fields for which to update selections.
<any-key>
\n<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
\nobject
A field with a single value selected.
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.
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.
title
\nstring
The title of the incident, which summarizes what happened.
id [required]
\nstring
The incident's ID.
relationships
\nobject
The incident's relationships for an update request.
commander_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
postmortem
\nobject
A relationship reference for postmortems.
data [required]
\nobject
The postmortem relationship data.
id [required]
\nstring
A unique identifier that represents the postmortem.
type [required]
\nenum
Incident postmortem resource type. \nAllowed enum values: incident_postmortems
default: incident_postmortems
type [required]
\nenum
Incident resource type. \nAllowed enum values: incidents
default: incidents
data [required]
\nobject
Incident integration metadata data for a create request.
attributes [required]
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\n[object]
An array of attachment data objects.
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>]
A list of related objects included in the response.
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 [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data
\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>]
A list of related objects included in the response.
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 [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data
\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
The unique identifier of the attachment.
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
data [required]
\nobject
Incident integration metadata data for a patch request.
attributes [required]
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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>]
A list of related objects included in the response.
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
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
data [required]
\n[object]
An array of incident todos.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
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.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Postmortem attachment data
attributes [required]
\nobject
Postmortem attachment attributes
cells
\n[object]
The cells of the postmortem
attributes
\nobject
Attributes of a postmortem cell
definition
\nobject
Definition of a postmortem cell
content
\nstring
The content of the cell in markdown format
id
\nstring
The unique identifier of the cell
type
\nenum
The postmortem cell resource type. \nAllowed enum values: markdown
content
\nstring
The content of the postmortem
postmortem_template_id
\nstring
The ID of the postmortem template
title
\nstring
The title of the postmortem
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
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>]
A list of related objects included in the response.
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 [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
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
data [required]
\nobject
Incident todo data for a create request.
attributes [required]
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\n[object]
An array of incident impacts.
attributes
\nobject
The incident impact's attributes.
created
\ndate-time
Timestamp when the impact was created.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
impact_type
\nstring
The type of impact.
modified
\ndate-time
Timestamp when the impact was last modified.
start_at [required]
\ndate-time
Timestamp representing when the impact started.
id [required]
\nstring
The incident impact's ID.
relationships
\nobject
The incident impact's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
included
\n[object]
Included related resources that the user requested.
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 [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident impact data from a response.
attributes
\nobject
The incident impact's attributes.
created
\ndate-time
Timestamp when the impact was created.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
impact_type
\nstring
The type of impact.
modified
\ndate-time
Timestamp when the impact was last modified.
start_at [required]
\ndate-time
Timestamp representing when the impact started.
id [required]
\nstring
The incident impact's ID.
relationships
\nobject
The incident impact's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
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
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
included
\n[object]
Included related resources that the user requested.
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 [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident impact data for a create request.
attributes [required]
\nobject
The incident impact's attributes for a create request.
description [required]
\nstring
Description of the impact.
end_at
\ndate-time
Timestamp when the impact ended.
fields
\nobject
An object mapping impact field names to field values.
start_at [required]
\ndate-time
Timestamp when the impact started.
type [required]
\nenum
Incident impact resource type. \nAllowed enum values: incident_impacts
default: incident_impacts
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident todo data for a patch request.
attributes [required]
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
data [required]
\n[object]
An array of incident integration metadata.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
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]
List of incident responders.
attributes [required]
\nobject
Attributes of an incident responder in a response.
created [required]
\ndate-time
Timestamp when the responder was created.
external_id
\nstring
The external ID of the responder.
external_source
\nstring
The external source of the responder.
is_billable [required]
\nboolean
Whether this responder counts toward billing.
last_active
\ndate-time
Timestamp when the responder was last active.
meta
\nobject
Additional metadata for the responder.
modified [required]
\ndate-time
Timestamp when the responder was last modified.
id [required]
\nuuid
The responder identifier.
relationships
\nobject
Relationships for an incident responder.
created_by
\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
last_modified_by
\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
role_assignments
\nobject
Relationship to role assignments for a responder.
data
\n[object]
List of role assignment relationship data.
id [required]
\nuuid
The role assignment identifier.
type [required]
\nstring
The role assignment resource type.
user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident responder resource type. \nAllowed enum values: incident_responders
included
\n[object]
Included related resources.
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 [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident responder data in a response.
attributes [required]
\nobject
Attributes of an incident responder in a response.
created [required]
\ndate-time
Timestamp when the responder was created.
external_id
\nstring
The external ID of the responder.
external_source
\nstring
The external source of the responder.
is_billable [required]
\nboolean
Whether this responder counts toward billing.
last_active
\ndate-time
Timestamp when the responder was last active.
meta
\nobject
Additional metadata for the responder.
modified [required]
\ndate-time
Timestamp when the responder was last modified.
id [required]
\nuuid
The responder identifier.
relationships
\nobject
Relationships for an incident responder.
created_by
\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
last_modified_by
\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
role_assignments
\nobject
Relationship to role assignments for a responder.
data
\n[object]
List of role assignment relationship data.
id [required]
\nuuid
The role assignment identifier.
type [required]
\nstring
The role assignment resource type.
user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident responder resource type. \nAllowed enum values: incident_responders
included
\n[object]
Included related resources.
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 [required]
\nobject
Incident integration metadata data for a create request.
attributes [required]
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
data [required]
\nobject
Incident responder data in a create request.
relationships [required]
\nobject
Relationships for creating an incident responder.
user [required]
\nobject
Relationship to a user for a responder create request.
data [required]
\nobject
A user relationship data object for creating a responder.
id [required]
\nuuid
The user identifier.
type [required]
\nstring
The user resource type.
type [required]
\nenum
Incident responder resource type. \nAllowed enum values: incident_responders
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
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
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
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident responder data in a response.
attributes [required]
\nobject
Attributes of an incident responder in a response.
created [required]
\ndate-time
Timestamp when the responder was created.
external_id
\nstring
The external ID of the responder.
external_source
\nstring
The external source of the responder.
is_billable [required]
\nboolean
Whether this responder counts toward billing.
last_active
\ndate-time
Timestamp when the responder was last active.
meta
\nobject
Additional metadata for the responder.
modified [required]
\ndate-time
Timestamp when the responder was last modified.
id [required]
\nuuid
The responder identifier.
relationships
\nobject
Relationships for an incident responder.
created_by
\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
last_modified_by
\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
role_assignments
\nobject
Relationship to role assignments for a responder.
data
\n[object]
List of role assignment relationship data.
id [required]
\nuuid
The role assignment identifier.
type [required]
\nstring
The role assignment resource type.
user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident responder resource type. \nAllowed enum values: incident_responders
included
\n[object]
Included related resources.
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 [required]
\nobject
Incident integration metadata data for a patch request.
attributes [required]
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
data [required]
\nobject
ServiceNow record data in a create request.
attributes [required]
\nobject
Attributes for creating a ServiceNow record for an incident.
assignment_group [required]
\nstring
The ServiceNow assignment group.
configuration_item_mapping [required]
\nstring
The ServiceNow configuration item mapping.
instance_name [required]
\nstring
The ServiceNow instance name.
record_id
\nstring
An existing ServiceNow record ID (Sys ID) to link instead of creating a new record.
type [required]
\nenum
ServiceNow record prompt resource type. \nAllowed enum values: incident_servicenow_record_prompt
data [required]
\n[object]
An array of incident todos.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
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.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
List of timestamp overrides.
attributes [required]
\nobject
Attributes of a timestamp override in a response.
created_at [required]
\ndate-time
Timestamp when the override was created.
deleted_at
\ndate-time
Timestamp when the override was deleted.
incident_id [required]
\nstring
The incident identifier.
modified_at [required]
\ndate-time
Timestamp when the override was last modified.
timestamp_type [required]
\nenum
The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared
timestamp_value [required]
\ndate-time
The overridden timestamp value.
id [required]
\nuuid
The timestamp override identifier.
relationships
\nobject
Relationships for a timestamp override.
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
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
Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides
included
\n[object]
Included related resources.
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 [required]
\nobject
Incident todo data for a create request.
attributes [required]
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
data [required]
\nobject
Timestamp override data in a response.
attributes [required]
\nobject
Attributes of a timestamp override in a response.
created_at [required]
\ndate-time
Timestamp when the override was created.
deleted_at
\ndate-time
Timestamp when the override was deleted.
incident_id [required]
\nstring
The incident identifier.
modified_at [required]
\ndate-time
Timestamp when the override was last modified.
timestamp_type [required]
\nenum
The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared
timestamp_value [required]
\ndate-time
The overridden timestamp value.
id [required]
\nuuid
The timestamp override identifier.
relationships
\nobject
Relationships for a timestamp override.
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
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
Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides
included
\n[object]
Included related resources.
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 [required]
\nobject
Timestamp override data in a create request.
attributes [required]
\nobject
Attributes for creating a timestamp override.
timestamp_type [required]
\nenum
The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared
timestamp_value [required]
\ndate-time
The overridden timestamp value.
type [required]
\nenum
Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Timestamp override data in a response.
attributes [required]
\nobject
Attributes of a timestamp override in a response.
created_at [required]
\ndate-time
Timestamp when the override was created.
deleted_at
\ndate-time
Timestamp when the override was deleted.
incident_id [required]
\nstring
The incident identifier.
modified_at [required]
\ndate-time
Timestamp when the override was last modified.
timestamp_type [required]
\nenum
The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared
timestamp_value [required]
\ndate-time
The overridden timestamp value.
id [required]
\nuuid
The timestamp override identifier.
relationships
\nobject
Relationships for a timestamp override.
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
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
Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides
included
\n[object]
Included related resources.
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 [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
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
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
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
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.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Timestamp override data in a response.
attributes [required]
\nobject
Attributes of a timestamp override in a response.
created_at [required]
\ndate-time
Timestamp when the override was created.
deleted_at
\ndate-time
Timestamp when the override was deleted.
incident_id [required]
\nstring
The incident identifier.
modified_at [required]
\ndate-time
Timestamp when the override was last modified.
timestamp_type [required]
\nenum
The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared
timestamp_value [required]
\ndate-time
The overridden timestamp value.
id [required]
\nuuid
The timestamp override identifier.
relationships
\nobject
Relationships for a timestamp override.
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
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
Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides
included
\n[object]
Included related resources.
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 [required]
\nobject
Incident todo data for a patch request.
attributes [required]
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
data [required]
\nobject
Timestamp override data in a patch request.
attributes
\nobject
Attributes for patching a timestamp override. All fields are optional.
timestamp_type
\nenum
The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared
timestamp_value
\ndate-time
The overridden timestamp value.
id [required]
\nuuid
The timestamp override identifier.
type [required]
\nenum
Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides