From 6a93d4789de23250f8302726144649ede6a17582 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Mon, 1 Jun 2026 08:35:06 +0000 Subject: [PATCH] Regenerate client from commit 0c82d0f of spec repo --- config/_default/menus/api.en.yaml | 481 + content/en/api/v2/incidents/examples.json | 10098 ++++++++++++++------ data/api/v2/full_spec.yaml | 5311 +++++++++- data/api/v2/translate_actions.json | 190 + 4 files changed, 12537 insertions(+), 3543 deletions(-) diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 1748fe7df8a..585bbab1a76 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -11569,6 +11569,123 @@ menu: url: /api/latest/incidents/ identifier: incidents generated: true + - name: Update an incident timestamp override + url: '#update-an-incident-timestamp-override' + identifier: incidents-update-an-incident-timestamp-override + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateTimestampOverride + unstable: + - v2 + order: 85 + - name: Delete an incident timestamp override + url: '#delete-an-incident-timestamp-override' + identifier: incidents-delete-an-incident-timestamp-override + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteTimestampOverride + unstable: + - v2 + order: 86 + - name: Create an incident timestamp override + url: '#create-an-incident-timestamp-override' + identifier: incidents-create-an-incident-timestamp-override + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateTimestampOverride + unstable: + - v2 + order: 84 + - name: List incident timestamp overrides + url: '#list-incident-timestamp-overrides' + identifier: incidents-list-incident-timestamp-overrides + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListTimestampOverrides + unstable: + - v2 + order: 83 + - name: Create an incident ServiceNow record + url: '#create-an-incident-servicenow-record' + identifier: incidents-create-an-incident-servicenow-record + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentServiceNowRecord + unstable: + - v2 + order: 89 + - name: Get an incident responder + url: '#get-an-incident-responder' + identifier: incidents-get-an-incident-responder + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - GetIncidentResponder + unstable: + - v2 + order: 81 + - name: Delete an incident responder + url: '#delete-an-incident-responder' + identifier: incidents-delete-an-incident-responder + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteIncidentResponder + unstable: + - v2 + order: 82 + - name: Create an incident responder + url: '#create-an-incident-responder' + identifier: incidents-create-an-incident-responder + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentResponder + unstable: + - v2 + order: 79 + - name: List incident responders + url: '#list-incident-responders' + identifier: incidents-list-incident-responders + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListIncidentResponders + unstable: + - v2 + order: 80 - name: Update an incident todo url: '#update-an-incident-todo' identifier: incidents-update-an-incident-todo @@ -11699,6 +11816,58 @@ menu: unstable: - v2 order: 51 + - name: Link a page to an incident + url: '#link-a-page-to-an-incident' + identifier: incidents-link-a-page-to-an-incident + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - LinkPageToIncident + unstable: + - v2 + order: 92 + - name: Create an on-call page from an incident + url: '#create-an-on-call-page-from-an-incident' + identifier: incidents-create-an-on-call-page-from-an-incident + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateOnCallPageFromIncident + unstable: + - v2 + order: 93 + - name: Update an incident impact + url: '#update-an-incident-impact' + identifier: incidents-update-an-incident-impact + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentImpact + unstable: + - v2 + order: 77 + - name: Patch an incident impact + url: '#patch-an-incident-impact' + identifier: incidents-patch-an-incident-impact + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - PatchIncidentImpact + unstable: + - v2 + order: 78 - name: Delete an incident impact url: '#delete-an-incident-impact' identifier: incidents-delete-an-incident-impact @@ -11735,6 +11904,45 @@ menu: - ListIncidentImpacts unstable: [] order: 7 + - name: Create an incident configuration + url: '#create-an-incident-configuration' + identifier: incidents-create-an-incident-configuration + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentConfiguration + unstable: + - v2 + order: 87 + - name: Update an incident configuration + url: '#update-an-incident-configuration' + identifier: incidents-update-an-incident-configuration + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentConfiguration + unstable: + - v2 + order: 88 + - name: Create a page from an incident + url: '#create-a-page-from-an-incident' + identifier: incidents-create-a-page-from-an-incident + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreatePageFromIncident + unstable: + - v2 + order: 90 - name: Update incident attachment url: '#update-incident-attachment' identifier: incidents-update-incident-attachment @@ -11800,6 +12008,19 @@ menu: unstable: - v2 order: 34 + - name: Get an AI-generated incident postmortem + url: '#get-an-ai-generated-incident-postmortem' + identifier: incidents-get-an-ai-generated-incident-postmortem + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - GetIncidentAIPostmortem + unstable: + - v2 + order: 91 - name: Update an existing incident url: '#update-an-existing-incident' identifier: incidents-update-an-existing-incident @@ -11865,6 +12086,71 @@ menu: unstable: - v2 order: 49 + - name: Update an incident user-defined role + url: '#update-an-incident-user-defined-role' + identifier: incidents-update-an-incident-user-defined-role + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentUserDefinedRole + unstable: + - v2 + order: 60 + - name: Get an incident user-defined role + url: '#get-an-incident-user-defined-role' + identifier: incidents-get-an-incident-user-defined-role + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - GetIncidentUserDefinedRole + unstable: + - v2 + order: 59 + - name: Delete an incident user-defined role + url: '#delete-an-incident-user-defined-role' + identifier: incidents-delete-an-incident-user-defined-role + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteIncidentUserDefinedRole + unstable: + - v2 + order: 61 + - name: Create an incident user-defined role + url: '#create-an-incident-user-defined-role' + identifier: incidents-create-an-incident-user-defined-role + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentUserDefinedRole + unstable: + - v2 + order: 58 + - name: List incident user-defined roles + url: '#list-incident-user-defined-roles' + identifier: incidents-list-incident-user-defined-roles + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListIncidentUserDefinedRoles + unstable: + - v2 + order: 57 - name: Update an incident user-defined field url: '#update-an-incident-user-defined-field' identifier: incidents-update-an-incident-user-defined-field @@ -11930,6 +12216,19 @@ menu: unstable: - v2 order: 52 + - name: Get org settings by incident type + url: '#get-org-settings-by-incident-type' + identifier: incidents-get-org-settings-by-incident-type + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - GetOrgSettingsByIncidentType + unstable: + - v2 + order: 76 - name: Update an incident type url: '#update-an-incident-type' identifier: incidents-update-an-incident-type @@ -11969,6 +12268,19 @@ menu: unstable: - v2 order: 23 + - name: List incident type org settings + url: '#list-incident-type-org-settings' + identifier: incidents-list-incident-type-org-settings + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListOrgSettings + unstable: + - v2 + order: 75 - name: Create an incident type url: '#create-an-incident-type' identifier: incidents-create-an-incident-type @@ -11995,6 +12307,71 @@ menu: unstable: - v2 order: 20 + - name: Update an incident rule + url: '#update-an-incident-rule' + identifier: incidents-update-an-incident-rule + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentRule + unstable: + - v2 + order: 69 + - name: Get an incident rule + url: '#get-an-incident-rule' + identifier: incidents-get-an-incident-rule + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - GetIncidentRule + unstable: + - v2 + order: 68 + - name: Delete an incident rule + url: '#delete-an-incident-rule' + identifier: incidents-delete-an-incident-rule + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteIncidentRule + unstable: + - v2 + order: 70 + - name: Create an incident rule + url: '#create-an-incident-rule' + identifier: incidents-create-an-incident-rule + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentRule + unstable: + - v2 + order: 67 + - name: List incident rules + url: '#list-incident-rules' + identifier: incidents-list-incident-rules + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListIncidentRules + unstable: + - v2 + order: 66 - name: Update postmortem template url: '#update-postmortem-template' identifier: incidents-update-postmortem-template @@ -12190,6 +12567,110 @@ menu: unstable: - v2 order: 29 + - name: Update an incident impact field + url: '#update-an-incident-impact-field' + identifier: incidents-update-an-incident-impact-field + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentImpactField + unstable: + - v2 + order: 73 + - name: Delete an incident impact field + url: '#delete-an-incident-impact-field' + identifier: incidents-delete-an-incident-impact-field + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteIncidentImpactField + unstable: + - v2 + order: 74 + - name: Create an incident impact field + url: '#create-an-incident-impact-field' + identifier: incidents-create-an-incident-impact-field + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentImpactField + unstable: + - v2 + order: 71 + - name: List incident impact fields + url: '#list-incident-impact-fields' + identifier: incidents-list-incident-impact-fields + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListIncidentImpactFields + unstable: + - v2 + order: 72 + - name: Update an incident Google Meet configuration + url: '#update-an-incident-google-meet-configuration' + identifier: incidents-update-an-incident-google-meet-configuration + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentGoogleMeetConfiguration + unstable: + - v2 + order: 65 + - name: Create an incident Google Meet configuration + url: '#create-an-incident-google-meet-configuration' + identifier: incidents-create-an-incident-google-meet-configuration + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentGoogleMeetConfiguration + unstable: + - v2 + order: 64 + - name: Update an incident Google Chat configuration + url: '#update-an-incident-google-chat-configuration' + identifier: incidents-update-an-incident-google-chat-configuration + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentGoogleChatConfiguration + unstable: + - v2 + order: 63 + - name: Create an incident Google Chat configuration + url: '#create-an-incident-google-chat-configuration' + identifier: incidents-create-an-incident-google-chat-configuration + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentGoogleChatConfiguration + unstable: + - v2 + order: 62 - name: Update global incident settings url: '#update-global-incident-settings' identifier: incidents-update-global-incident-settings diff --git a/content/en/api/v2/incidents/examples.json b/content/en/api/v2/incidents/examples.json index f972a4356ad..5c7fadebfa4 100644 --- a/content/en/api/v2/incidents/examples.json +++ b/content/en/api/v2/incidents/examples.json @@ -942,129 +942,57 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object in the global incident settings request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Global incident settings attributes

\n
\n
\n
\n
\n
\n

analytics_dashboard_id

\n
\n

string

\n

The analytics dashboard ID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Global incident settings resource type \nAllowed enum values: incidents_global_settings

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentNotificationRules": { + "CreateIncidentGoogleChatConfiguration": { "responses": { - "200": { + "201": { "json": { - "data": [ - { - "attributes": { - "conditions": [ - { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] - } - ], - "created": "2025-01-15T10:30:00Z", - "enabled": true, - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "modified": "2025-01-15T14:45:00Z", - "renotify_on": [ - "status", - "severity" - ], - "trigger": "incident_created_trigger", - "visibility": "organization" + "data": { + "attributes": { + "created_at": "2024-01-01T00:00:00.000Z", + "domain_id": "my-domain", + "modified_at": "2024-01-01T00:00:00.000Z", + "space_name_template": "{{incident.title}}", + "space_target_audience_id": "123456789", + "space_time_zone": "America/New_York" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } }, - "id": "00000000-0000-0000-0000-000000000001", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" } }, - "type": "incident_notification_rules" - } - ], + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "google_chat_configurations" + }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } - ], - "meta": { - "pagination": { - "next_offset": 15, - "offset": 0, - "size": 15 - } - } + ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationRuleArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The offset for the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The current offset in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The number of results returned per page.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Chat configuration data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a Google Chat configuration.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

domain_id [required]

\n
\n

string

\n

The Google Chat domain ID.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

space_name_template [required]

\n
\n

string

\n

The template for the Google Chat space name.

\n
\n \n
\n
\n
\n
\n
\n

space_target_audience_id [required]

\n
\n

string

\n

The target audience ID for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n

space_time_zone [required]

\n
\n

string

\n

The time zone for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a Google Chat configuration.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1090,14 +1018,6 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "404": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, "429": { "json": { "errors": [ @@ -1108,41 +1028,61 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "attributes": { + "domain_id": "my-domain", + "space_name_template": "{{incident.title}}", + "space_target_audience_id": "123456789", + "space_time_zone": "America/New_York" + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "google_chat_configurations" + } + }, + "json": { + "data": { + "attributes": { + "domain_id": "my-domain", + "space_name_template": "{{incident.title}}", + "space_target_audience_id": "123456789", + "space_time_zone": "America/New_York" + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "google_chat_configurations" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Chat configuration data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a Google Chat configuration.

\n
\n
\n
\n
\n
\n

domain_id [required]

\n
\n

string

\n

The Google Chat domain ID.

\n
\n \n
\n
\n
\n
\n
\n

space_name_template [required]

\n
\n

string

\n

The template for the Google Chat space name.

\n
\n \n
\n
\n
\n
\n
\n

space_target_audience_id [required]

\n
\n

string

\n

The target audience ID for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n

space_time_zone [required]

\n
\n

string

\n

The time zone for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for a Google Chat configuration create request.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations

\n
\n \n
\n
\n
\n
" } }, - "CreateIncidentNotificationRule": { + "UpdateIncidentGoogleChatConfiguration": { "responses": { - "201": { + "200": { "json": { "data": { "attributes": { - "conditions": [ - { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] - } - ], - "created": "2025-01-15T10:30:00Z", - "enabled": true, - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "modified": "2025-01-15T14:45:00Z", - "renotify_on": [ - "status", - "severity" - ], - "trigger": "incident_created_trigger", - "visibility": "organization" + "created_at": "2024-01-01T00:00:00.000Z", + "domain_id": "my-domain", + "modified_at": "2024-01-01T00:00:00.000Z", + "space_name_template": "{{incident.title}}", + "space_target_audience_id": "123456789", + "space_time_zone": "America/New_York" }, - "id": "00000000-0000-0000-0000-000000000001", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { @@ -1161,72 +1101,25 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } } }, - "type": "incident_notification_rules" + "type": "google_chat_configurations" }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Chat configuration data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a Google Chat configuration.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

domain_id [required]

\n
\n

string

\n

The Google Chat domain ID.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n

space_name_template [required]

\n
\n

string

\n

The template for the Google Chat space name.

\n
\n \n
\n
\n
\n
\n
\n

space_target_audience_id [required]

\n
\n

string

\n

The target audience ID for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n

space_time_zone [required]

\n
\n

string

\n

The time zone for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a Google Chat configuration.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1271,95 +1164,77 @@ }, "request": { "json_curl": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_chat_configurations" + } + }, + "json": { "data": { "attributes": { - "conditions": [ - { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] - } - ], - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "trigger": "incident_created_trigger" - }, - "relationships": { - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } - } - }, - "type": "incident_notification_rules" - } - }, - "json": { - "data": { - "attributes": { - "conditions": [ - { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] - } - ], - "enabled": true, - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "renotify_on": [ - "status", - "severity" - ], - "trigger": "incident_created_trigger", - "visibility": "organization" - }, - "relationships": { - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } - } + "domain_id": "my-domain", + "space_name_template": "{{incident.title}}", + "space_target_audience_id": "123456789", + "space_time_zone": "America/New_York" }, - "type": "incident_notification_rules" + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_chat_configurations" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating a notification rule.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of NotificationRuleCreateDataRelationships object.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Chat configuration data in a patch request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for patching a Google Chat configuration. All fields are optional.

\n
\n
\n
\n
\n
\n

domain_id

\n
\n

string

\n

The Google Chat domain ID.

\n
\n \n
\n
\n
\n
\n
\n

space_name_template

\n
\n

string

\n

The template for the Google Chat space name.

\n
\n \n
\n
\n
\n
\n
\n

space_target_audience_id

\n
\n

string

\n

The target audience ID for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n

space_time_zone

\n
\n

string

\n

The time zone for the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Chat configuration resource type. \nAllowed enum values: google_chat_configurations

\n
\n \n
\n
\n
\n
" } }, - "DeleteIncidentNotificationRule": { + "CreateIncidentGoogleMeetConfiguration": { "responses": { - "400": { + "201": { "json": { - "errors": [ - "Bad Request" + "data": { + "attributes": { + "allow_manual_meeting_creation": true, + "auto_summarize": false, + "created_at": "2024-01-01T00:00:00.000Z", + "modified_at": "2024-01-01T00:00:00.000Z" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "google_meet_configurations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Meet configuration data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a Google Meet configuration.

\n
\n
\n
\n
\n
\n

allow_manual_meeting_creation [required]

\n
\n

boolean

\n

Whether manual meeting creation is allowed.

\n
\n \n
\n
\n
\n
\n
\n

auto_summarize [required]

\n
\n

boolean

\n

Whether meetings are auto-summarized.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a Google Meet configuration.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, - "401": { + "400": { "json": { "errors": [ "Bad Request" @@ -1367,7 +1242,7 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "403": { + "401": { "json": { "errors": [ "Bad Request" @@ -1375,7 +1250,7 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "404": { + "403": { "json": { "errors": [ "Bad Request" @@ -1393,41 +1268,55 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "attributes": { + "allow_manual_meeting_creation": true, + "auto_summarize": false + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "google_meet_configurations" + } + }, + "json": { + "data": { + "attributes": { + "allow_manual_meeting_creation": true, + "auto_summarize": false + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "google_meet_configurations" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Meet configuration data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a Google Meet configuration.

\n
\n
\n
\n
\n
\n

allow_manual_meeting_creation [required]

\n
\n

boolean

\n

Whether to allow manual meeting creation.

\n
\n \n
\n
\n
\n
\n
\n

auto_summarize [required]

\n
\n

boolean

\n

Whether to auto-summarize meetings.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for a Google Meet configuration create request.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations

\n
\n \n
\n
\n
\n
" } }, - "GetIncidentNotificationRule": { + "UpdateIncidentGoogleMeetConfiguration": { "responses": { "200": { "json": { "data": { "attributes": { - "conditions": [ - { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] - } - ], - "created": "2025-01-15T10:30:00Z", - "enabled": true, - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "modified": "2025-01-15T14:45:00Z", - "renotify_on": [ - "status", - "severity" - ], - "trigger": "incident_created_trigger", - "visibility": "organization" + "allow_manual_meeting_creation": true, + "auto_summarize": false, + "created_at": "2024-01-01T00:00:00.000Z", + "modified_at": "2024-01-01T00:00:00.000Z" }, - "id": "00000000-0000-0000-0000-000000000001", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { @@ -1446,72 +1335,25 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } } }, - "type": "incident_notification_rules" + "type": "google_meet_configurations" }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Meet configuration data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a Google Meet configuration.

\n
\n
\n
\n
\n
\n

allow_manual_meeting_creation [required]

\n
\n

boolean

\n

Whether manual meeting creation is allowed.

\n
\n \n
\n
\n
\n
\n
\n

auto_summarize [required]

\n
\n

boolean

\n

Whether meetings are auto-summarized.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a Google Meet configuration.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1555,41 +1397,142 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_meet_configurations" + } + }, + "json": { + "data": { + "attributes": { + "allow_manual_meeting_creation": true, + "auto_summarize": false + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_meet_configurations" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Meet configuration data in a patch request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for patching a Google Meet configuration. All fields are optional.

\n
\n
\n
\n
\n
\n

allow_manual_meeting_creation

\n
\n

boolean

\n

Whether to allow manual meeting creation.

\n
\n \n
\n
\n
\n
\n
\n

auto_summarize

\n
\n

boolean

\n

Whether to auto-summarize meetings.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Google Meet configuration resource type. \nAllowed enum values: google_meet_configurations

\n
\n \n
\n
\n
\n
" } }, - "UpdateIncidentNotificationRule": { + "ListIncidentImpactFields": { "responses": { "200": { "json": { - "data": { - "attributes": { - "conditions": [ - { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] - } - ], - "created": "2025-01-15T10:30:00Z", - "enabled": true, - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "modified": "2025-01-15T14:45:00Z", - "renotify_on": [ - "status", - "severity" + "data": [ + { + "attributes": { + "display_name": "Customer Impact Scope", + "field_choices": [ + { + "description": "Affects all customers", + "display_name": "Critical", + "value": "critical" + } + ], + "field_type": "dropdown", + "name": "customer_impact_scope", + "tag_key": "env" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "impact_fields" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of impact fields.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an impact field in a response.

\n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

field_choices

\n
\n

[object]

\n

The choices for dropdown or multiselect fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the choice.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the choice.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the choice.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

field_type [required]

\n
\n

enum

\n

The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The normalized name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

The tag key associated with the field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The impact field identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an impact field.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Impact field resource type. \nAllowed enum values: impact_fields

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentImpactField": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "display_name": "Customer Impact Scope", + "field_choices": [ + { + "description": "Affects all customers", + "display_name": "Critical", + "value": "critical" + } ], - "trigger": "incident_created_trigger", - "visibility": "organization" + "field_type": "dropdown", + "name": "customer_impact_scope", + "tag_key": "env" }, - "id": "00000000-0000-0000-0000-000000000001", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { @@ -1608,72 +1551,25 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } } }, - "type": "incident_notification_rules" + "type": "impact_fields" }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Impact field data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an impact field in a response.

\n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

field_choices

\n
\n

[object]

\n

The choices for dropdown or multiselect fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the choice.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the choice.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the choice.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

field_type [required]

\n
\n

enum

\n

The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The normalized name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

The tag key associated with the field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The impact field identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an impact field.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Impact field resource type. \nAllowed enum values: impact_fields

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1699,14 +1595,6 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "404": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, "429": { "json": { "errors": [ @@ -1720,186 +1608,59 @@ "json_curl": { "data": { "attributes": { - "conditions": [ + "display_name": "Customer Impact Scope", + "field_choices": [ { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] + "display_name": "Critical", + "value": "critical" } ], - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "trigger": "incident_created_trigger" + "field_type": "dropdown", + "name": "customer_impact_scope" }, - "id": "00000000-0000-0000-0000-000000000001", "relationships": { "incident_type": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types" } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } } }, - "type": "incident_notification_rules" + "type": "impact_fields" } }, "json": { "data": { "attributes": { - "conditions": [ + "display_name": "Customer Impact Scope", + "field_choices": [ { - "field": "severity", - "values": [ - "SEV-1", - "SEV-2" - ] + "description": "Affects all customers", + "display_name": "Critical", + "value": "critical" } ], - "enabled": true, - "handles": [ - "@team-email@company.com", - "@slack-channel" - ], - "renotify_on": [ - "status", - "severity" - ], - "trigger": "incident_created_trigger", - "visibility": "organization" + "field_type": "dropdown", + "name": "customer_impact_scope", + "tag_key": "env" }, - "id": "00000000-0000-0000-0000-000000000001", "relationships": { "incident_type": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types" } - }, - "notification_template": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } } }, - "type": "incident_notification_rules" + "type": "impact_fields" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data for an update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating a notification rule.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of NotificationRuleCreateDataRelationships object.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Impact field data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an impact field.

\n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

field_choices

\n
\n

[object]

\n

The choices for dropdown or multiselect fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the choice.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the choice.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the choice.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

field_type [required]

\n
\n

enum

\n

The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The normalized name of the impact field (used as identifier).

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

The tag key associated with the field (for metrictag type).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for an impact field create request.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Impact field resource type. \nAllowed enum values: impact_fields

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentNotificationTemplates": { + "DeleteIncidentImpactField": { "responses": { - "200": { - "json": { - "data": [ - { - "attributes": { - "category": "alert", - "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", - "created": "2025-01-15T10:30:00Z", - "modified": "2025-01-15T14:45:00Z", - "name": "Incident Alert Template", - "subject": "{{incident.severity}} Incident: {{incident.title}}" - }, - "id": "00000000-0000-0000-0000-000000000001", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } - }, - "type": "notification_templates" - } - ], - "included": [ - { - "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, - "email": "string", - "handle": "string", - "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", - "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false - }, - "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, - "type": "users" - } - ], - "meta": { - "page": { - "total_count": 42, - "total_filtered_count": 15 - } - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationTemplateArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total number of notification templates.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total number of notification templates matching the filter.

\n
\n \n
\n
\n
\n
\n
\n
" - }, - "400": { + "400": { "json": { "errors": [ "Bad Request" @@ -1946,20 +1707,25 @@ "html": "" } }, - "CreateIncidentNotificationTemplate": { + "UpdateIncidentImpactField": { "responses": { - "201": { + "200": { "json": { "data": { "attributes": { - "category": "alert", - "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", - "created": "2025-01-15T10:30:00Z", - "modified": "2025-01-15T14:45:00Z", - "name": "Incident Alert Template", - "subject": "{{incident.severity}} Incident: {{incident.title}}" + "display_name": "Customer Impact Scope", + "field_choices": [ + { + "description": "Affects all customers", + "display_name": "Critical", + "value": "critical" + } + ], + "field_type": "dropdown", + "name": "customer_impact_scope", + "tag_key": "env" }, - "id": "00000000-0000-0000-0000-000000000001", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { @@ -1980,8 +1746,179 @@ } } }, - "type": "notification_templates" + "type": "impact_fields" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Impact field data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an impact field in a response.

\n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

field_choices

\n
\n

[object]

\n

The choices for dropdown or multiselect fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the choice.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the choice.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the choice.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

field_type [required]

\n
\n

enum

\n

The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The normalized name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

The tag key associated with the field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The impact field identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an impact field.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Impact field resource type. \nAllowed enum values: impact_fields

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "display_name": "Customer Impact Scope", + "field_choices": [ + { + "display_name": "Critical", + "value": "critical" + } + ], + "field_type": "dropdown", + "name": "customer_impact_scope" + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "impact_fields" + } + }, + "json": { + "data": { + "attributes": { + "display_name": "Customer Impact Scope", + "field_choices": [ + { + "description": "Affects all customers", + "display_name": "Critical", + "value": "critical" + } + ], + "field_type": "dropdown", + "name": "customer_impact_scope", + "tag_key": "env" + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } }, + "type": "impact_fields" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Impact field data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an impact field.

\n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the impact field.

\n
\n \n
\n
\n
\n
\n
\n

field_choices

\n
\n

[object]

\n

The choices for dropdown or multiselect fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the choice.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The display name of the choice.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value of the choice.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

field_type [required]

\n
\n

enum

\n

The type of an impact field. \nAllowed enum values: dropdown,text,textarray,metrictag,number,datetime,multiselect

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The normalized name of the impact field (used as identifier).

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

The tag key associated with the field (for metrictag type).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for an impact field create request.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Impact field resource type. \nAllowed enum values: impact_fields

\n
\n \n
\n
\n
\n
" + } + }, + "ListIncidentNotificationRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "created": "2025-01-15T10:30:00Z", + "enabled": true, + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], + "modified": "2025-01-15T14:45:00Z", + "renotify_on": [ + "status", + "severity" + ], + "trigger": "incident_created_trigger", + "visibility": "organization" + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + } + }, + "type": "incident_notification_rules" + } + ], "included": [ { "attributes": { @@ -2035,9 +1972,16 @@ }, "type": "users" } - ] + ], + "meta": { + "pagination": { + "next_offset": 15, + "offset": 0, + "size": 15 + } + } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationRuleArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The offset for the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The current offset in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The number of results returned per page.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -2080,109 +2024,40 @@ "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" } }, - "request": { - "json_curl": { - "data": { - "attributes": { - "category": "alert", - "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", - "name": "Incident Alert Template", - "subject": "{{incident.severity}} Incident: {{incident.title}}" - }, - "relationships": { - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - } - }, - "type": "notification_templates" - } - }, - "json": { - "data": { - "attributes": { - "category": "alert", - "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", - "name": "Incident Alert Template", - "subject": "{{incident.severity}} Incident: {{incident.title}}" - }, - "relationships": { - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - } - }, - "type": "notification_templates" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating a notification template.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of NotificationTemplateCreateDataRelationships object.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
" - } - }, - "DeleteIncidentNotificationTemplate": { - "responses": { - "400": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "401": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "403": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "404": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "429": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, "request": { "json_curl": {}, "json": {}, "html": "" } }, - "GetIncidentNotificationTemplate": { + "CreateIncidentNotificationRule": { "responses": { - "200": { + "201": { "json": { "data": { "attributes": { - "category": "alert", - "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], "created": "2025-01-15T10:30:00Z", + "enabled": true, + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], "modified": "2025-01-15T14:45:00Z", - "name": "Incident Alert Template", - "subject": "{{incident.severity}} Incident: {{incident.title}}" + "renotify_on": [ + "status", + "severity" + ], + "trigger": "incident_created_trigger", + "visibility": "organization" }, "id": "00000000-0000-0000-0000-000000000001", "relationships": { @@ -2203,9 +2078,15 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } } }, - "type": "notification_templates" + "type": "incident_notification_rules" }, "included": [ { @@ -2262,8 +2143,131 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], + "trigger": "incident_created_trigger" + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + } + }, + "type": "incident_notification_rules" + } + }, + "json": { + "data": { + "attributes": { + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "enabled": true, + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], + "renotify_on": [ + "status", + "severity" + ], + "trigger": "incident_created_trigger", + "visibility": "organization" + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + } + }, + "type": "incident_notification_rules" + } }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating a notification rule.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of NotificationRuleCreateDataRelationships object.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteIncidentNotificationRule": { + "responses": { "400": { "json": { "errors": [ @@ -2311,20 +2315,36 @@ "html": "" } }, - "UpdateIncidentNotificationTemplate": { + "GetIncidentNotificationRule": { "responses": { "200": { "json": { "data": { "attributes": { - "category": "alert", - "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], "created": "2025-01-15T10:30:00Z", + "enabled": true, + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], "modified": "2025-01-15T14:45:00Z", - "name": "Incident Alert Template", - "subject": "{{incident.severity}} Incident: {{incident.title}}" - }, - "id": "00000000-0000-0000-0000-000000000001", + "renotify_on": [ + "status", + "severity" + ], + "trigger": "incident_created_trigger", + "visibility": "organization" + }, + "id": "00000000-0000-0000-0000-000000000001", "relationships": { "created_by_user": { "data": { @@ -2343,9 +2363,15 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } } }, - "type": "notification_templates" + "type": "incident_notification_rules" }, "included": [ { @@ -2402,7 +2428,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -2446,129 +2472,157 @@ } }, "request": { - "json_curl": { - "data": { - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } - }, - "json": { - "data": { - "attributes": { - "category": "update", - "content": "Incident Status Update:\n\nTitle: {{incident.title}}\nNew Status: {{incident.state}}\nSeverity: {{incident.severity}}\nServices: {{incident.services}}\nCommander: {{incident.commander}}\n\nFor more details, visit the incident page.", - "name": "Incident Status Update Template", - "subject": "Incident Update: {{incident.title}} - {{incident.state}}" - }, - "id": "00000000-0000-0000-0000-000000000001", - "type": "notification_templates" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data for an update request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes to update on a notification template.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
" + "json_curl": {}, + "json": {}, + "html": "" } }, - "ListIncidentPostmortemTemplates": { + "UpdateIncidentNotificationRule": { "responses": { "200": { "json": { - "data": [ + "data": { + "attributes": { + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "created": "2025-01-15T10:30:00Z", + "enabled": true, + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], + "modified": "2025-01-15T14:45:00Z", + "renotify_on": [ + "status", + "severity" + ], + "trigger": "incident_created_trigger", + "visibility": "organization" + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + } + }, + "type": "incident_notification_rules" + }, + "included": [ { "attributes": { - "createdAt": "2026-01-13T17:15:53.208340Z", - "modifiedAt": "2026-01-13T17:15:53.208340Z", - "name": "Standard Postmortem Template" + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, - "id": "template-456", - "type": "postmortem_template" + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, + "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of postmortem template data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "429": { + "401": { "json": { "errors": [ "Bad Request" ] }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, - "request": { - "json_curl": {}, - "json": {}, - "html": "" - } - }, - "CreateIncidentPostmortemTemplate": { - "responses": { - "201": { - "json": { - "data": { - "attributes": { - "createdAt": "2026-01-13T17:15:53.208340Z", - "modifiedAt": "2026-01-13T17:15:53.208340Z", - "name": "Standard Postmortem Template" - }, - "id": "template-456", - "type": "postmortem_template" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" }, - "400": { + "403": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "403": { + "404": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -2583,126 +2637,216 @@ "json_curl": { "data": { "attributes": { - "name": "Standard Postmortem Template" + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], + "trigger": "incident_created_trigger" }, - "type": "postmortem_template" + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + } + }, + "type": "incident_notification_rules" } }, "json": { "data": { "attributes": { - "name": "Standard Postmortem Template" + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "enabled": true, + "handles": [ + "@team-email@company.com", + "@slack-channel" + ], + "renotify_on": [ + "status", + "severity" + ], + "trigger": "incident_created_trigger", + "visibility": "organization" }, - "type": "postmortem_template" + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "notification_template": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + } + }, + "type": "incident_notification_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data for an update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating a notification rule.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of NotificationRuleCreateDataRelationships object.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
" } }, - "DeleteIncidentPostmortemTemplate": { + "ListIncidentNotificationTemplates": { "responses": { - "400": { + "200": { "json": { - "errors": [ + "data": [ { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" + "attributes": { + "category": "alert", + "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "created": "2025-01-15T10:30:00Z", + "modified": "2025-01-15T14:45:00Z", + "name": "Incident Alert Template", + "subject": "{{incident.severity}} Incident: {{incident.title}}" }, - "status": "400", - "title": "Bad Request" + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "notification_templates" } - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" - }, - "404": { - "json": { - "errors": [ + ], + "included": [ { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, - "status": "400", - "title": "Bad Request" + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, + "type": "users" } - ] + ], + "meta": { + "page": { + "total_count": 42, + "total_filtered_count": 15 + } + } }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationTemplateArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total number of notification templates.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total number of notification templates matching the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, - "429": { + "400": { "json": { "errors": [ "Bad Request" ] }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, - "request": { - "json_curl": {}, - "json": {}, - "html": "" - } - }, - "GetIncidentPostmortemTemplate": { - "responses": { - "200": { + }, + "401": { "json": { - "data": { - "attributes": { - "createdAt": "2026-01-13T17:15:53.208340Z", - "modifiedAt": "2026-01-13T17:15:53.208340Z", - "name": "Standard Postmortem Template" - }, - "id": "template-456", - "type": "postmortem_template" - } + "errors": [ + "Bad Request" + ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "400": { + "403": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "404": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -2719,57 +2863,130 @@ "html": "" } }, - "UpdateIncidentPostmortemTemplate": { + "CreateIncidentNotificationTemplate": { "responses": { - "200": { + "201": { "json": { "data": { "attributes": { - "createdAt": "2026-01-13T17:15:53.208340Z", - "modifiedAt": "2026-01-13T17:15:53.208340Z", - "name": "Standard Postmortem Template" + "category": "alert", + "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "created": "2025-01-15T10:30:00Z", + "modified": "2025-01-15T14:45:00Z", + "name": "Incident Alert Template", + "subject": "{{incident.severity}} Incident: {{incident.title}}" }, - "id": "template-456", - "type": "postmortem_template" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" - }, - "400": { - "json": { - "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } }, - "status": "400", - "title": "Bad Request" + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "notification_templates" + }, + "included": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false + }, + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, + "type": "users" } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "404": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -2784,78 +3001,55 @@ "json_curl": { "data": { "attributes": { - "name": "Standard Postmortem Template" + "category": "alert", + "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "name": "Incident Alert Template", + "subject": "{{incident.severity}} Incident: {{incident.title}}" }, - "type": "postmortem_template" + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "notification_templates" } }, "json": { "data": { "attributes": { - "name": "Standard Postmortem Template" + "category": "alert", + "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "name": "Incident Alert Template", + "subject": "{{incident.severity}} Incident: {{incident.title}}" }, - "type": "postmortem_template" + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "notification_templates" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating a notification template.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of NotificationTemplateCreateDataRelationships object.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentTypes": { + "DeleteIncidentNotificationTemplate": { "responses": { - "200": { + "400": { "json": { - "data": [ - { - "attributes": { - "createdAt": "2019-09-19T10:00:00.000Z", - "createdBy": "00000000-0000-0000-0000-000000000000", - "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "is_default": false, - "lastModifiedBy": "00000000-0000-0000-0000-000000000000", - "modifiedAt": "2019-09-19T10:00:00.000Z", - "name": "Security Incident", - "prefix": "IR" - }, - "id": "00000000-0000-0000-0000-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "google_meet_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "google_meet_configurations" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "microsoft_teams_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "microsoft_teams_configurations" - } - }, - "zoom_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "zoom_configurations" - } - } - }, - "type": "incident_types" - } + "errors": [ + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident type objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "400": { + "401": { "json": { "errors": [ "Bad Request" @@ -2863,7 +3057,7 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "401": { + "403": { "json": { "errors": [ "Bad Request" @@ -2871,7 +3065,7 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "403": { + "404": { "json": { "errors": [ "Bad Request" @@ -2894,22 +3088,20 @@ "html": "" } }, - "CreateIncidentType": { + "GetIncidentNotificationTemplate": { "responses": { - "201": { + "200": { "json": { "data": { "attributes": { - "createdAt": "2019-09-19T10:00:00.000Z", - "createdBy": "00000000-0000-0000-0000-000000000000", - "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "is_default": false, - "lastModifiedBy": "00000000-0000-0000-0000-000000000000", - "modifiedAt": "2019-09-19T10:00:00.000Z", - "name": "Security Incident", - "prefix": "IR" + "category": "alert", + "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "created": "2025-01-15T10:30:00Z", + "modified": "2025-01-15T14:45:00Z", + "name": "Incident Alert Template", + "subject": "{{incident.severity}} Incident: {{incident.title}}" }, - "id": "00000000-0000-0000-0000-000000000000", + "id": "00000000-0000-0000-0000-000000000001", "relationships": { "created_by_user": { "data": { @@ -2917,10 +3109,10 @@ "type": "users" } }, - "google_meet_configuration": { + "incident_type": { "data": { "id": "00000000-0000-0000-0000-000000000000", - "type": "google_meet_configurations" + "type": "incident_types" } }, "last_modified_by_user": { @@ -2928,90 +3120,67 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } - }, - "microsoft_teams_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "microsoft_teams_configurations" - } - }, - "zoom_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "zoom_configurations" - } } }, - "type": "incident_types" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" - }, - "400": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "401": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "403": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "404": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "429": { - "json": { - "errors": [ - "Bad Request" + "type": "notification_templates" + }, + "included": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false + }, + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, + "type": "users" + } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, - "request": { - "json_curl": { - "data": { - "attributes": { - "name": "Security Incident" - }, - "type": "incident_types" - } - }, - "json": { - "data": { - "attributes": { - "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "is_default": false, - "name": "Security Incident" - }, - "type": "incident_types" - } + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" - } - }, - "DeleteIncidentType": { - "responses": { "400": { "json": { "errors": [ @@ -3059,22 +3228,20 @@ "html": "" } }, - "GetIncidentType": { + "UpdateIncidentNotificationTemplate": { "responses": { "200": { "json": { "data": { "attributes": { - "createdAt": "2019-09-19T10:00:00.000Z", - "createdBy": "00000000-0000-0000-0000-000000000000", - "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "is_default": false, - "lastModifiedBy": "00000000-0000-0000-0000-000000000000", - "modifiedAt": "2019-09-19T10:00:00.000Z", - "name": "Security Incident", - "prefix": "IR" + "category": "alert", + "content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.", + "created": "2025-01-15T10:30:00Z", + "modified": "2025-01-15T14:45:00Z", + "name": "Incident Alert Template", + "subject": "{{incident.severity}} Incident: {{incident.title}}" }, - "id": "00000000-0000-0000-0000-000000000000", + "id": "00000000-0000-0000-0000-000000000001", "relationships": { "created_by_user": { "data": { @@ -3082,10 +3249,10 @@ "type": "users" } }, - "google_meet_configuration": { + "incident_type": { "data": { "id": "00000000-0000-0000-0000-000000000000", - "type": "google_meet_configurations" + "type": "incident_types" } }, "last_modified_by_user": { @@ -3093,24 +3260,66 @@ "id": "00000000-0000-0000-2345-000000000000", "type": "users" } + } + }, + "type": "notification_templates" + }, + "included": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, - "microsoft_teams_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "microsoft_teams_configurations" + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] } }, - "zoom_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "zoom_configurations" - } - } - }, - "type": "incident_types" - } + "type": "users" + } + ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3154,95 +3363,129 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + }, + "json": { + "data": { + "attributes": { + "category": "update", + "content": "Incident Status Update:\n\nTitle: {{incident.title}}\nNew Status: {{incident.state}}\nSeverity: {{incident.severity}}\nServices: {{incident.services}}\nCommander: {{incident.commander}}\n\nFor more details, visit the incident page.", + "name": "Incident Status Update Template", + "subject": "Incident Update: {{incident.title}} - {{incident.state}}" + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "notification_templates" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data for an update request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes to update on a notification template.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
" } }, - "UpdateIncidentType": { + "ListIncidentPostmortemTemplates": { "responses": { "200": { "json": { - "data": { - "attributes": { - "createdAt": "2019-09-19T10:00:00.000Z", - "createdBy": "00000000-0000-0000-0000-000000000000", - "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "is_default": false, - "lastModifiedBy": "00000000-0000-0000-0000-000000000000", - "modifiedAt": "2019-09-19T10:00:00.000Z", - "name": "Security Incident", - "prefix": "IR" - }, - "id": "00000000-0000-0000-0000-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "google_meet_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "google_meet_configurations" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } + "data": [ + { + "attributes": { + "createdAt": "2026-01-13T17:15:53.208340Z", + "modifiedAt": "2026-01-13T17:15:53.208340Z", + "name": "Standard Postmortem Template" }, - "microsoft_teams_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "microsoft_teams_configurations" - } - }, - "zoom_configuration": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "zoom_configurations" - } - } - }, - "type": "incident_types" - } + "id": "template-456", + "type": "postmortem_template" + } + ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of postmortem template data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" }, "400": { "json": { "errors": [ - "Bad Request" + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, - "401": { + "429": { "json": { "errors": [ "Bad Request" ] }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentPostmortemTemplate": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "createdAt": "2026-01-13T17:15:53.208340Z", + "modifiedAt": "2026-01-13T17:15:53.208340Z", + "name": "Standard Postmortem Template" + }, + "id": "template-456", + "type": "postmortem_template" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" }, - "403": { + "400": { "json": { "errors": [ - "Bad Request" + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, - "404": { + "403": { "json": { "errors": [ - "Bad Request" + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, "429": { "json": { @@ -3256,97 +3499,44 @@ "request": { "json_curl": { "data": { - "attributes": {}, - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" + "attributes": { + "name": "Standard Postmortem Template" + }, + "type": "postmortem_template" } }, "json": { "data": { "attributes": { - "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", - "is_default": false, - "name": "Security Incident" + "name": "Standard Postmortem Template" }, - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" + "type": "postmortem_template" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type data for a patch request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident type's attributes for updates.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

When true, this incident type will be used as the default type when an incident type is not specified.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentUserDefinedFields": { + "DeleteIncidentPostmortemTemplate": { "responses": { - "200": { + "400": { "json": { - "data": [ + "errors": [ { - "attributes": { - "attached_to": "incidents", - "category": "what_happened", - "collected": "active", - "created": "2026-03-18T08:40:05.185406Z", - "default_value": "critical", - "deleted": null, - "display_name": "Root Cause", - "metadata": { - "category": "teams_and_services", - "search_limit_param": "page[size]", - "search_params": {}, - "search_query_param": "filter", - "search_result_path": "$.data[*].attributes.name", - "search_url": "/api/v2/incidents/config/services" - }, - "modified": "2026-03-18T08:40:05.185406Z", - "name": "root_cause", - "ordinal": "1.5", - "prerequisite": null, - "required": false, - "reserved": false, - "table_id": 0, - "tag_key": null, - "type": 3, - "valid_values": [ - { - "description": "A critical severity incident.", - "display_name": "Critical", - "short_description": "Critical", - "value": "critical" - } - ] - }, - "id": "00000000-0000-0000-0000-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" }, - "type": "user_defined_field" + "status": "400", + "title": "Bad Request" } - ], - "meta": { - "offset": 0, - "size": 5 - } + ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user-defined field objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Pagination metadata for the user-defined field list response.

\n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset of the current page.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The total number of items in the current page.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, - "400": { + "404": { "json": { "errors": [ { @@ -3364,21 +3554,72 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, - "401": { + "429": { "json": { "errors": [ "Bad Request" ] }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentPostmortemTemplate": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "createdAt": "2026-01-13T17:15:53.208340Z", + "modifiedAt": "2026-01-13T17:15:53.208340Z", + "name": "Standard Postmortem Template" + }, + "id": "template-456", + "type": "postmortem_template" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" }, - "403": { + "400": { "json": { "errors": [ - "Bad Request" + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, "429": { "json": { @@ -3395,70 +3636,21 @@ "html": "" } }, - "CreateIncidentUserDefinedField": { + "UpdateIncidentPostmortemTemplate": { "responses": { - "201": { + "200": { "json": { "data": { "attributes": { - "attached_to": "incidents", - "category": "what_happened", - "collected": "active", - "created": "2026-03-18T08:40:05.185406Z", - "default_value": "critical", - "deleted": null, - "display_name": "Root Cause", - "metadata": { - "category": "teams_and_services", - "search_limit_param": "page[size]", - "search_params": {}, - "search_query_param": "filter", - "search_result_path": "$.data[*].attributes.name", - "search_url": "/api/v2/incidents/config/services" - }, - "modified": "2026-03-18T08:40:05.185406Z", - "name": "root_cause", - "ordinal": "1.5", - "prerequisite": null, - "required": false, - "reserved": false, - "table_id": 0, - "tag_key": null, - "type": 3, - "valid_values": [ - { - "description": "A critical severity incident.", - "display_name": "Critical", - "short_description": "Critical", - "value": "critical" - } - ] - }, - "id": "00000000-0000-0000-0000-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } + "createdAt": "2026-01-13T17:15:53.208340Z", + "modifiedAt": "2026-01-13T17:15:53.208340Z", + "name": "Standard Postmortem Template" }, - "type": "user_defined_field" + "id": "template-456", + "type": "postmortem_template" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an incident user-defined field response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a postmortem template returned in a response.

\n
\n
\n
\n
\n
\n

createdAt [required]

\n
\n

date-time

\n

When the template was created

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt [required]

\n
\n

date-time

\n

When the template was last modified

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the template

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -3478,22 +3670,6 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" }, - "401": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "403": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, "404": { "json": { "errors": [ @@ -3525,82 +3701,65 @@ "json_curl": { "data": { "attributes": { - "name": "root_cause", - "type": 3, - "valid_values": [ - { - "display_name": "Critical", - "value": "critical" - } - ] - }, - "relationships": { - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - } + "name": "Standard Postmortem Template" }, - "type": "user_defined_field" + "type": "postmortem_template" } }, "json": { "data": { "attributes": { - "category": "what_happened", - "collected": "active", - "default_value": "critical", - "display_name": "Root Cause", - "name": "root_cause", - "ordinal": "1.5", - "required": false, - "tag_key": "datacenter", - "type": 3, - "valid_values": [ - { - "description": "A critical severity incident.", - "display_name": "Critical", - "short_description": "Critical", - "value": "critical" - } - ] - }, - "relationships": { - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - } + "name": "Standard Postmortem Template" }, - "type": "user_defined_field" + "type": "postmortem_template" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for creating an incident user-defined field.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an incident user-defined field.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value for the field. Must be one of the valid values when valid_values is set.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.

\n
\n \n
\n
\n
\n
\n
\n

ordinal

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

valid_values

\n
\n

[object]

\n

The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for creating an incident user-defined field.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating or updating a postmortem template.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Postmortem template resource type \nAllowed enum values: postmortem_template

\n
\n \n
\n
\n
\n
" } }, - "DeleteIncidentUserDefinedField": { + "ListIncidentRules": { "responses": { - "400": { + "200": { "json": { - "errors": [ + "data": [ { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" + "attributes": { + "condition": { + "normalized_query": "severity:SEV-1", + "raw_query": "severity:SEV-1" + }, + "condition_table_type": 1, + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "created": "2024-01-01T00:00:00.000Z", + "created_by_uuid": "00000000-0000-0000-0000-000000000001", + "deleted": null, + "enabled": true, + "execution_type": 1, + "incident_settings_association_uuid": null, + "match_any_condition": false, + "modified": "2024-01-01T00:00:00.000Z", + "modified_by_uuid": "00000000-0000-0000-0000-000000000001", + "org_id": 123456, + "task_id": "notify-incident-handles-job", + "task_payload": "{}", + "trigger": "incident_created_trigger" }, - "status": "400", - "title": "Bad Request" + "id": "00000000-0000-0000-0000-000000000000", + "type": "incidents_rules" } ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of incident rules.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident rule in a response.

\n
\n
\n
\n
\n
\n

condition

\n
\n

object

\n

A query-based condition for an incident rule.

\n
\n
\n
\n
\n
\n

normalized_query

\n
\n

string

\n

The normalized query string.

\n
\n \n
\n
\n
\n
\n
\n

raw_query

\n
\n

string

\n

The raw query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition_table_type

\n
\n

integer

\n

The condition table type.

\n
\n \n
\n
\n
\n
\n
\n

conditions

\n
\n

[object]

\n

List of field-based conditions.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The field to match on.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The values to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by_uuid

\n
\n

uuid

\n

UUID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Timestamp when the rule was deleted.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

execution_type

\n
\n

integer

\n

The execution type of the rule.

\n
\n \n
\n
\n
\n
\n
\n

incident_settings_association_uuid

\n
\n

uuid

\n

The incident settings association UUID.

\n
\n \n
\n
\n
\n
\n
\n

match_any_condition

\n
\n

boolean

\n

Whether any condition should match.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_uuid

\n
\n

uuid

\n

UUID of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

org_id

\n
\n

int64

\n

The organization ID.

\n
\n \n
\n
\n
\n
\n
\n

task_id

\n
\n

string

\n

The task ID.

\n
\n \n
\n
\n
\n
\n
\n

task_payload

\n
\n

string

\n

The JSON-encoded task payload.

\n
\n \n
\n
\n
\n
\n
\n

trigger

\n
\n

string

\n

The trigger event for the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The rule identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident rule response resource type. \nAllowed enum values: incidents_rules

\n
\n \n
\n
\n
\n
" }, - "401": { + "400": { "json": { "errors": [ "Bad Request" @@ -3608,7 +3767,7 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "403": { + "401": { "json": { "errors": [ "Bad Request" @@ -3616,23 +3775,13 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "404": { + "403": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -3649,72 +3798,47 @@ "html": "" } }, - "GetIncidentUserDefinedField": { + "CreateIncidentRule": { "responses": { - "200": { + "201": { "json": { "data": { "attributes": { - "attached_to": "incidents", - "category": "what_happened", - "collected": "active", - "created": "2026-03-18T08:40:05.185406Z", - "default_value": "critical", - "deleted": null, - "display_name": "Root Cause", - "metadata": { - "category": "teams_and_services", - "search_limit_param": "page[size]", - "search_params": {}, - "search_query_param": "filter", - "search_result_path": "$.data[*].attributes.name", - "search_url": "/api/v2/incidents/config/services" + "condition": { + "normalized_query": "severity:SEV-1", + "raw_query": "severity:SEV-1" }, - "modified": "2026-03-18T08:40:05.185406Z", - "name": "root_cause", - "ordinal": "1.5", - "prerequisite": null, - "required": false, - "reserved": false, - "table_id": 0, - "tag_key": null, - "type": 3, - "valid_values": [ + "condition_table_type": 1, + "conditions": [ { - "description": "A critical severity incident.", - "display_name": "Critical", - "short_description": "Critical", - "value": "critical" + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] } - ] + ], + "created": "2024-01-01T00:00:00.000Z", + "created_by_uuid": "00000000-0000-0000-0000-000000000001", + "deleted": null, + "enabled": true, + "execution_type": 1, + "incident_settings_association_uuid": null, + "match_any_condition": false, + "modified": "2024-01-01T00:00:00.000Z", + "modified_by_uuid": "00000000-0000-0000-0000-000000000001", + "org_id": 123456, + "task_id": "notify-incident-handles-job", + "task_payload": "{}", + "trigger": "incident_created_trigger" }, "id": "00000000-0000-0000-0000-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } - }, - "type": "user_defined_field" + "type": "incidents_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an incident user-defined field response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident rule data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident rule in a response.

\n
\n
\n
\n
\n
\n

condition

\n
\n

object

\n

A query-based condition for an incident rule.

\n
\n
\n
\n
\n
\n

normalized_query

\n
\n

string

\n

The normalized query string.

\n
\n \n
\n
\n
\n
\n
\n

raw_query

\n
\n

string

\n

The raw query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition_table_type

\n
\n

integer

\n

The condition table type.

\n
\n \n
\n
\n
\n
\n
\n

conditions

\n
\n

[object]

\n

List of field-based conditions.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The field to match on.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The values to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by_uuid

\n
\n

uuid

\n

UUID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Timestamp when the rule was deleted.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

execution_type

\n
\n

integer

\n

The execution type of the rule.

\n
\n \n
\n
\n
\n
\n
\n

incident_settings_association_uuid

\n
\n

uuid

\n

The incident settings association UUID.

\n
\n \n
\n
\n
\n
\n
\n

match_any_condition

\n
\n

boolean

\n

Whether any condition should match.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_uuid

\n
\n

uuid

\n

UUID of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

org_id

\n
\n

int64

\n

The organization ID.

\n
\n \n
\n
\n
\n
\n
\n

task_id

\n
\n

string

\n

The task ID.

\n
\n \n
\n
\n
\n
\n
\n

task_payload

\n
\n

string

\n

The JSON-encoded task payload.

\n
\n \n
\n
\n
\n
\n
\n

trigger

\n
\n

string

\n

The trigger event for the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The rule identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident rule response resource type. \nAllowed enum values: incidents_rules

\n
\n \n
\n
\n
\n
" }, - "401": { + "400": { "json": { "errors": [ "Bad Request" @@ -3722,7 +3846,7 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "403": { + "401": { "json": { "errors": [ "Bad Request" @@ -3730,23 +3854,13 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "404": { + "403": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -3758,93 +3872,242 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" - } - }, - "UpdateIncidentUserDefinedField": { + "json_curl": { + "data": { + "attributes": { + "condition": {}, + "condition_table_type": 1, + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "enabled": true, + "execution_type": 1, + "task_id": "notify-incident-handles-job", + "task_payload": "{}" + }, + "type": "incident_rules" + } + }, + "json": { + "data": { + "attributes": { + "condition": { + "normalized_query": "severity:SEV-1", + "raw_query": "severity:SEV-1" + }, + "condition_table_type": 1, + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] + } + ], + "enabled": true, + "execution_type": 1, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", + "match_any_condition": false, + "task_id": "notify-incident-handles-job", + "task_payload": "{}", + "trigger": "incident_created_trigger" + }, + "type": "incident_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident rule data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an incident rule.

\n
\n
\n
\n
\n
\n

condition [required]

\n
\n

object

\n

A query-based condition for an incident rule.

\n
\n
\n
\n
\n
\n

normalized_query

\n
\n

string

\n

The normalized query string.

\n
\n \n
\n
\n
\n
\n
\n

raw_query

\n
\n

string

\n

The raw query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition_table_type [required]

\n
\n

integer

\n

The condition table type. 1 = raw query.

\n
\n \n
\n
\n
\n
\n
\n

conditions

\n
\n

[object]

\n

List of field-based conditions.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The field to match on.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The values to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

execution_type [required]

\n
\n

enum

\n

The execution type of an incident rule. \nAllowed enum values: 1,2

\n
\n \n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

uuid

\n

The UUID of the incident type this rule applies to.

\n
\n \n
\n
\n
\n
\n
\n

match_any_condition

\n
\n

boolean

\n

Whether any condition (OR logic) should match instead of all (AND logic).

\n
\n \n
\n
\n
\n
\n
\n

task_id [required]

\n
\n

enum

\n

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-job

Show 2 more,ms-teams-suppress-summarization-job,google-meet-suppress-summarization-job

\n
\n \n
\n
\n
\n
\n
\n

task_payload [required]

\n
\n

string

\n

The JSON-encoded payload for the task.

\n
\n \n
\n
\n
\n
\n
\n

trigger

\n
\n

enum

\n

The trigger event for an incident rule. \nAllowed enum values: incident_saved_trigger,incident_created_trigger,incident_modified_trigger

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident rule resource type. \nAllowed enum values: incident_rules

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteIncidentRule": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentRule": { "responses": { "200": { "json": { "data": { "attributes": { - "attached_to": "incidents", - "category": "what_happened", - "collected": "active", - "created": "2026-03-18T08:40:05.185406Z", - "default_value": "critical", - "deleted": null, - "display_name": "Root Cause", - "metadata": { - "category": "teams_and_services", - "search_limit_param": "page[size]", - "search_params": {}, - "search_query_param": "filter", - "search_result_path": "$.data[*].attributes.name", - "search_url": "/api/v2/incidents/config/services" + "condition": { + "normalized_query": "severity:SEV-1", + "raw_query": "severity:SEV-1" }, - "modified": "2026-03-18T08:40:05.185406Z", - "name": "root_cause", - "ordinal": "1.5", - "prerequisite": null, - "required": false, - "reserved": false, - "table_id": 0, - "tag_key": null, - "type": 3, - "valid_values": [ + "condition_table_type": 1, + "conditions": [ { - "description": "A critical severity incident.", - "display_name": "Critical", - "short_description": "Critical", - "value": "critical" + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] } - ] + ], + "created": "2024-01-01T00:00:00.000Z", + "created_by_uuid": "00000000-0000-0000-0000-000000000001", + "deleted": null, + "enabled": true, + "execution_type": 1, + "incident_settings_association_uuid": null, + "match_any_condition": false, + "modified": "2024-01-01T00:00:00.000Z", + "modified_by_uuid": "00000000-0000-0000-0000-000000000001", + "org_id": 123456, + "task_id": "notify-incident-handles-job", + "task_payload": "{}", + "trigger": "incident_created_trigger" }, "id": "00000000-0000-0000-0000-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident_type": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" - } + "type": "incidents_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident rule data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident rule in a response.

\n
\n
\n
\n
\n
\n

condition

\n
\n

object

\n

A query-based condition for an incident rule.

\n
\n
\n
\n
\n
\n

normalized_query

\n
\n

string

\n

The normalized query string.

\n
\n \n
\n
\n
\n
\n
\n

raw_query

\n
\n

string

\n

The raw query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition_table_type

\n
\n

integer

\n

The condition table type.

\n
\n \n
\n
\n
\n
\n
\n

conditions

\n
\n

[object]

\n

List of field-based conditions.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The field to match on.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The values to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by_uuid

\n
\n

uuid

\n

UUID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Timestamp when the rule was deleted.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

execution_type

\n
\n

integer

\n

The execution type of the rule.

\n
\n \n
\n
\n
\n
\n
\n

incident_settings_association_uuid

\n
\n

uuid

\n

The incident settings association UUID.

\n
\n \n
\n
\n
\n
\n
\n

match_any_condition

\n
\n

boolean

\n

Whether any condition should match.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_uuid

\n
\n

uuid

\n

UUID of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

org_id

\n
\n

int64

\n

The organization ID.

\n
\n \n
\n
\n
\n
\n
\n

task_id

\n
\n

string

\n

The task ID.

\n
\n \n
\n
\n
\n
\n
\n

task_payload

\n
\n

string

\n

The JSON-encoded task payload.

\n
\n \n
\n
\n
\n
\n
\n

trigger

\n
\n

string

\n

The trigger event for the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The rule identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident rule response resource type. \nAllowed enum values: incidents_rules

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIncidentRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "condition": { + "normalized_query": "severity:SEV-1", + "raw_query": "severity:SEV-1" }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" + "condition_table_type": 1, + "conditions": [ + { + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] } - } + ], + "created": "2024-01-01T00:00:00.000Z", + "created_by_uuid": "00000000-0000-0000-0000-000000000001", + "deleted": null, + "enabled": true, + "execution_type": 1, + "incident_settings_association_uuid": null, + "match_any_condition": false, + "modified": "2024-01-01T00:00:00.000Z", + "modified_by_uuid": "00000000-0000-0000-0000-000000000001", + "org_id": 123456, + "task_id": "notify-incident-handles-job", + "task_payload": "{}", + "trigger": "incident_created_trigger" }, - "type": "user_defined_field" + "id": "00000000-0000-0000-0000-000000000000", + "type": "incidents_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an incident user-defined field response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident rule data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident rule in a response.

\n
\n
\n
\n
\n
\n

condition

\n
\n

object

\n

A query-based condition for an incident rule.

\n
\n
\n
\n
\n
\n

normalized_query

\n
\n

string

\n

The normalized query string.

\n
\n \n
\n
\n
\n
\n
\n

raw_query

\n
\n

string

\n

The raw query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

condition_table_type

\n
\n

integer

\n

The condition table type.

\n
\n \n
\n
\n
\n
\n
\n

conditions

\n
\n

[object]

\n

List of field-based conditions.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The field to match on.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The values to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the rule was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by_uuid

\n
\n

uuid

\n

UUID of the user who created the rule.

\n
\n \n
\n
\n
\n
\n
\n

deleted

\n
\n

date-time

\n

Timestamp when the rule was deleted.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

execution_type

\n
\n

integer

\n

The execution type of the rule.

\n
\n \n
\n
\n
\n
\n
\n

incident_settings_association_uuid

\n
\n

uuid

\n

The incident settings association UUID.

\n
\n \n
\n
\n
\n
\n
\n

match_any_condition

\n
\n

boolean

\n

Whether any condition should match.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by_uuid

\n
\n

uuid

\n

UUID of the user who last modified the rule.

\n
\n \n
\n
\n
\n
\n
\n

org_id

\n
\n

int64

\n

The organization ID.

\n
\n \n
\n
\n
\n
\n
\n

task_id

\n
\n

string

\n

The task ID.

\n
\n \n
\n
\n
\n
\n
\n

task_payload

\n
\n

string

\n

The JSON-encoded task payload.

\n
\n \n
\n
\n
\n
\n
\n

trigger

\n
\n

string

\n

The trigger event for the rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The rule identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident rule response resource type. \nAllowed enum values: incidents_rules

\n
\n \n
\n
\n
\n
" }, "400": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "401": { "json": { @@ -3865,20 +4128,10 @@ "404": { "json": { "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" - } + "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -3893,173 +4146,193 @@ "json_curl": { "data": { "attributes": { - "valid_values": [ + "conditions": [ { - "display_name": "Critical", - "value": "critical" + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] } ] }, "id": "00000000-0000-0000-0000-000000000000", - "type": "user_defined_field" + "type": "incident_rules" } }, "json": { "data": { "attributes": { - "category": "what_happened", - "collected": "active", - "default_value": "critical", - "display_name": "Root Cause", - "ordinal": "1.5", - "required": false, - "valid_values": [ + "condition": { + "normalized_query": "severity:SEV-1", + "raw_query": "severity:SEV-1" + }, + "conditions": [ { - "description": "A critical severity incident.", - "display_name": "Critical", - "short_description": "Critical", - "value": "critical" + "field": "severity", + "values": [ + "SEV-1", + "SEV-2" + ] } - ] + ], + "enabled": true, + "task_payload": "{}", + "trigger": "incident_created_trigger" }, "id": "00000000-0000-0000-0000-000000000000", - "type": "user_defined_field" + "type": "incident_rules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for updating an incident user-defined field.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an incident user-defined field. All fields are optional.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value for the field. Must be one of the valid values when valid_values is set.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

ordinal

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

valid_values

\n
\n

[object]

\n

The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field to update.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident rule data in a patch request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for patching an incident rule. All fields are optional.

\n
\n
\n
\n
\n
\n

condition

\n
\n

object

\n

A query-based condition for an incident rule.

\n
\n
\n
\n
\n
\n

normalized_query

\n
\n

string

\n

The normalized query string.

\n
\n \n
\n
\n
\n
\n
\n

raw_query

\n
\n

string

\n

The raw query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

conditions

\n
\n

[object]

\n

List of field-based conditions.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The field to match on.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The values to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

task_payload

\n
\n

string

\n

The JSON-encoded payload for the task.

\n
\n \n
\n
\n
\n
\n
\n

trigger

\n
\n

enum

\n

The trigger event for an incident rule. \nAllowed enum values: incident_saved_trigger,incident_created_trigger,incident_modified_trigger

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The rule identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident rule resource type. \nAllowed enum values: incident_rules

\n
\n \n
\n
\n
\n
" } }, - "ImportIncident": { + "ListIncidentTypes": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "createdAt": "2019-09-19T10:00:00.000Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "is_default": false, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "google_meet_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_meet_configurations" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "microsoft_teams_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "microsoft_teams_configurations" + } + }, + "zoom_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "zoom_configurations" + } + } + }, + "type": "incident_types" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident type objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentType": { "responses": { "201": { "json": { "data": { "attributes": { - "archived": "2019-09-19T10:00:00.000Z", - "case_id": "integer", - "created": "2025-01-01T00:00:00Z", - "created_by_uuid": "string", - "creation_idempotency_key": "string", - "customer_impact_end": "2019-09-19T10:00:00.000Z", - "customer_impact_scope": "An example customer impact scope", - "customer_impact_start": "2019-09-19T10:00:00.000Z", - "declared": "2025-01-01T00:00:00Z", - "declared_by_uuid": "string", - "detected": "2025-01-01T00:00:00Z", - "fields": { - "": "undefined" - }, - "incident_type_uuid": "00000000-0000-0000-0000-000000000000", - "is_test": false, - "last_modified_by_uuid": "string", - "modified": "2019-09-19T10:00:00.000Z", - "non_datadog_creator": { - "image_48_px": "string", - "name": "string" - }, - "notification_handles": [ - { - "display_name": "Jane Doe", - "handle": "@test.user@test.com" - } - ], - "public_id": 1, - "resolved": "2019-09-19T10:00:00.000Z", - "severity": "UNKNOWN", - "state": "string", - "title": "A test incident title", - "visibility": "string" + "createdAt": "2019-09-19T10:00:00.000Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "is_default": false, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { - "attachments": { - "data": [ - { - "id": "00000000-0000-abcd-1000-000000000000", - "type": "incident_attachments" - } - ] - }, - "commander_user": { + "created_by_user": { "data": { - "id": "00000000-0000-0000-0000-000000000000", + "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, - "created_by_user": { + "google_meet_configuration": { "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_meet_configurations" } }, - "declared_by_user": { + "last_modified_by_user": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, - "impacts": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_impacts" - } - ] - }, - "incident_type": { + "microsoft_teams_configuration": { "data": { "id": "00000000-0000-0000-0000-000000000000", - "type": "incident_types" + "type": "microsoft_teams_configurations" } }, - "integrations": { - "data": [ - { - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "last_modified_by_user": { + "zoom_configuration": { "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" + "id": "00000000-0000-0000-0000-000000000000", + "type": "zoom_configurations" } - }, - "responders": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_responders" - } - ] - }, - "user_defined_fields": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "user_defined_field" - } - ] } }, - "type": "incidents" - }, - "included": [ - { - "attributes": { - "email": "string", - "handle": "string", - "icon": "string", - "name": "string", - "uuid": "string" - }, - "id": "string", - "type": "users" - } - ] + "type": "incident_types" + } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from an import response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from an import response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case ID.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by_uuid

\n
\n

string

\n

UUID of the user who created the incident.

\n
\n \n
\n
\n
\n
\n
\n

creation_idempotency_key

\n
\n

string

\n

A unique key used to ensure idempotent incident creation.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began to be impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_uuid

\n
\n

string

\n

UUID of the user who last modified the incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that are notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state of the incident.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident that summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from an import response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -4106,279 +4379,3843 @@ "json_curl": { "data": { "attributes": { - "title": "Imported incident from external system" - }, - "relationships": { - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - }, - "declared_by_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - } + "name": "Security Incident" }, - "type": "incidents" + "type": "incident_types" } }, "json": { "data": { "attributes": { - "declared": "2025-01-01T00:00:00Z", - "detected": "2025-01-01T00:00:00Z", - "fields": { + "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "is_default": false, + "name": "Security Incident" + }, + "type": "incident_types" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + } + }, + "ListOrgSettings": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created": "2024-01-01T00:00:00.000Z", + "modified": "2024-01-01T00:00:00.000Z", + "settings": { + "allow_anonymous_incident_declaration": false, + "allow_guest_incident_declaration": false, + "pagerduty_paging": true, + "private_incidents_by_default": false + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "incident_org_settings" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of incident org settings resources.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident org settings resource in a response.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the settings were created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the settings were last modified.

\n
\n \n
\n
\n
\n
\n
\n

settings [required]

\n
\n

object

\n

The settings configuration for an incident org settings resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The org settings identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident org settings resource.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident org settings resource type. \nAllowed enum values: incident_org_settings

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "DeleteIncidentType": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentType": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "createdAt": "2019-09-19T10:00:00.000Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "is_default": false, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "google_meet_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_meet_configurations" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "microsoft_teams_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "microsoft_teams_configurations" + } + }, + "zoom_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "zoom_configurations" + } + } + }, + "type": "incident_types" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIncidentType": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "createdAt": "2019-09-19T10:00:00.000Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "is_default": false, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "google_meet_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "google_meet_configurations" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "microsoft_teams_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "microsoft_teams_configurations" + } + }, + "zoom_configuration": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "zoom_configurations" + } + } + }, + "type": "incident_types" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": {}, + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "json": { + "data": { + "attributes": { + "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "is_default": false, + "name": "Security Incident" + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident type data for a patch request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident type's attributes for updates.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

When true, this incident type will be used as the default type when an incident type is not specified.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
" + } + }, + "GetOrgSettingsByIncidentType": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created": "2024-01-01T00:00:00.000Z", + "modified": "2024-01-01T00:00:00.000Z", + "settings": { + "allow_anonymous_incident_declaration": false, + "allow_guest_incident_declaration": false, + "pagerduty_paging": true, + "private_incidents_by_default": false + } + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "incident_org_settings" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident org settings data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident org settings resource in a response.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the settings were created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the settings were last modified.

\n
\n \n
\n
\n
\n
\n
\n

settings [required]

\n
\n

object

\n

The settings configuration for an incident org settings resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The org settings identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident org settings resource.

\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident org settings resource type. \nAllowed enum values: incident_org_settings

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "ListIncidentUserDefinedFields": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "attached_to": "incidents", + "category": "what_happened", + "collected": "active", + "created": "2026-03-18T08:40:05.185406Z", + "default_value": "critical", + "deleted": null, + "display_name": "Root Cause", + "metadata": { + "category": "teams_and_services", + "search_limit_param": "page[size]", + "search_params": {}, + "search_query_param": "filter", + "search_result_path": "$.data[*].attributes.name", + "search_url": "/api/v2/incidents/config/services" + }, + "modified": "2026-03-18T08:40:05.185406Z", + "name": "root_cause", + "ordinal": "1.5", + "prerequisite": null, + "required": false, + "reserved": false, + "table_id": 0, + "tag_key": null, + "type": 3, + "valid_values": [ + { + "description": "A critical severity incident.", + "display_name": "Critical", + "short_description": "Critical", + "value": "critical" + } + ] + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "user_defined_field" + } + ], + "meta": { + "offset": 0, + "size": 5 + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user-defined field objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Pagination metadata for the user-defined field list response.

\n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset of the current page.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The total number of items in the current page.

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentUserDefinedField": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "attached_to": "incidents", + "category": "what_happened", + "collected": "active", + "created": "2026-03-18T08:40:05.185406Z", + "default_value": "critical", + "deleted": null, + "display_name": "Root Cause", + "metadata": { + "category": "teams_and_services", + "search_limit_param": "page[size]", + "search_params": {}, + "search_query_param": "filter", + "search_result_path": "$.data[*].attributes.name", + "search_url": "/api/v2/incidents/config/services" + }, + "modified": "2026-03-18T08:40:05.185406Z", + "name": "root_cause", + "ordinal": "1.5", + "prerequisite": null, + "required": false, + "reserved": false, + "table_id": 0, + "tag_key": null, + "type": 3, + "valid_values": [ + { + "description": "A critical severity incident.", + "display_name": "Critical", + "short_description": "Critical", + "value": "critical" + } + ] + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "user_defined_field" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an incident user-defined field response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "name": "root_cause", + "type": 3, + "valid_values": [ + { + "display_name": "Critical", + "value": "critical" + } + ] + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "user_defined_field" + } + }, + "json": { + "data": { + "attributes": { + "category": "what_happened", + "collected": "active", + "default_value": "critical", + "display_name": "Root Cause", + "name": "root_cause", + "ordinal": "1.5", + "required": false, + "tag_key": "datacenter", + "type": 3, + "valid_values": [ + { + "description": "A critical severity incident.", + "display_name": "Critical", + "short_description": "Critical", + "value": "critical" + } + ] + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + } + }, + "type": "user_defined_field" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for creating an incident user-defined field.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an incident user-defined field.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value for the field. Must be one of the valid values when valid_values is set.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.

\n
\n \n
\n
\n
\n
\n
\n

ordinal

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

tag_key

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

valid_values

\n
\n

[object]

\n

The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for creating an incident user-defined field.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteIncidentUserDefinedField": { + "responses": { + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentUserDefinedField": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "attached_to": "incidents", + "category": "what_happened", + "collected": "active", + "created": "2026-03-18T08:40:05.185406Z", + "default_value": "critical", + "deleted": null, + "display_name": "Root Cause", + "metadata": { + "category": "teams_and_services", + "search_limit_param": "page[size]", + "search_params": {}, + "search_query_param": "filter", + "search_result_path": "$.data[*].attributes.name", + "search_url": "/api/v2/incidents/config/services" + }, + "modified": "2026-03-18T08:40:05.185406Z", + "name": "root_cause", + "ordinal": "1.5", + "prerequisite": null, + "required": false, + "reserved": false, + "table_id": 0, + "tag_key": null, + "type": 3, + "valid_values": [ + { + "description": "A critical severity incident.", + "display_name": "Critical", + "short_description": "Critical", + "value": "critical" + } + ] + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "user_defined_field" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an incident user-defined field response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIncidentUserDefinedField": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "attached_to": "incidents", + "category": "what_happened", + "collected": "active", + "created": "2026-03-18T08:40:05.185406Z", + "default_value": "critical", + "deleted": null, + "display_name": "Root Cause", + "metadata": { + "category": "teams_and_services", + "search_limit_param": "page[size]", + "search_params": {}, + "search_query_param": "filter", + "search_result_path": "$.data[*].attributes.name", + "search_url": "/api/v2/incidents/config/services" + }, + "modified": "2026-03-18T08:40:05.185406Z", + "name": "root_cause", + "ordinal": "1.5", + "prerequisite": null, + "required": false, + "reserved": false, + "table_id": 0, + "tag_key": null, + "type": 3, + "valid_values": [ + { + "description": "A critical severity incident.", + "display_name": "Critical", + "short_description": "Critical", + "value": "critical" + } + ] + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "user_defined_field" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for an incident user-defined field response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined field.

\n
\n
\n
\n
\n
\n

attached_to [required]

\n
\n

string

\n

The resource type this field is attached to. Always "incidents".

\n
\n \n
\n
\n
\n
\n
\n

category [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected [required]

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the field was created.

\n
\n \n
\n
\n
\n
\n
\n

default_value [required]

\n
\n

string

\n

The default value for the field.

\n
\n \n
\n
\n
\n
\n
\n

deleted [required]

\n
\n

date-time

\n

Timestamp when the field was soft-deleted, or null if not deleted.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the autocomplete source.

\n
\n \n
\n
\n
\n
\n
\n

search_limit_param [required]

\n
\n

string

\n

The query parameter used to limit the number of autocomplete results.

\n
\n \n
\n
\n
\n
\n
\n

search_params [required]

\n
\n

object

\n

Additional query parameters to include in the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_query_param [required]

\n
\n

string

\n

The query parameter used to pass typed input to the search URL.

\n
\n \n
\n
\n
\n
\n
\n

search_result_path [required]

\n
\n

string

\n

The JSON path to the results in the response body.

\n
\n \n
\n
\n
\n
\n
\n

search_url [required]

\n
\n

string

\n

The URL used to populate autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the field was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The unique identifier of the field.

\n
\n \n
\n
\n
\n
\n
\n

ordinal [required]

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

prerequisite [required]

\n
\n

string

\n

Reserved for future use. Always null.

\n
\n \n
\n
\n
\n
\n
\n

required [required]

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

reserved [required]

\n
\n

boolean

\n

When true, this field is reserved for system use and cannot be deleted.

\n
\n \n
\n
\n
\n
\n
\n

table_id [required]

\n
\n

int64

\n

Reserved for internal use. Always 0.

\n
\n \n
\n
\n
\n
\n
\n

tag_key [required]

\n
\n

string

\n

For metric tag-type fields only, the metric tag key that powers the autocomplete options.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

int32

\n

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.

\n
\n \n
\n
\n
\n
\n
\n

valid_values [required]

\n
\n

[object]

\n

The list of allowed values for dropdown, multiselect, and autocomplete fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of an incident user-defined field.

\n
\n
\n
\n
\n
\n

created_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user [required]

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "valid_values": [ + { + "display_name": "Critical", + "value": "critical" + } + ] + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "user_defined_field" + } + }, + "json": { + "data": { + "attributes": { + "category": "what_happened", + "collected": "active", + "default_value": "critical", + "display_name": "Root Cause", + "ordinal": "1.5", + "required": false, + "valid_values": [ + { + "description": "A critical severity incident.", + "display_name": "Critical", + "short_description": "Critical", + "value": "critical" + } + ] + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "user_defined_field" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for updating an incident user-defined field.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating an incident user-defined field. All fields are optional.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

collected

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

string

\n

The default value for the field. Must be one of the valid values when valid_values is set.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The human-readable name shown in the UI.

\n
\n \n
\n
\n
\n
\n
\n

ordinal

\n
\n

string

\n

A decimal string representing the field's display order in the UI.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

boolean

\n

When true, users must fill out this field on incidents.

\n
\n \n
\n
\n
\n
\n
\n

valid_values

\n
\n

[object]

\n

The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A detailed description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

The human-readable display name for this value.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

A short description of the valid value.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The identifier that is stored when this option is selected.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the user-defined field to update.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
" + } + }, + "ListIncidentUserDefinedRoles": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created": "2024-01-01T00:00:00.000Z", + "description": "The technical lead for the incident.", + "modified": "2024-01-01T00:00:00.000Z", + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "id": "00000000-0000-0000-0000-000000000002", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_user_defined_roles" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of incident user-defined role data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined role.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the role was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the role was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

policy [required]

\n
\n

object

\n

Policy configuration for a user-defined role.

\n
\n
\n
\n
\n
\n

is_single [required]

\n
\n

boolean

\n

Whether this role can only be assigned to one responder at a time.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a user-defined role response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type for a user-defined role.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for the incident type relationship of a user-defined role.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included resources for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentUserDefinedRole": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created": "2024-01-01T00:00:00.000Z", + "description": "The technical lead for the incident.", + "modified": "2024-01-01T00:00:00.000Z", + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "id": "00000000-0000-0000-0000-000000000002", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_user_defined_roles" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined role.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the role was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the role was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

policy [required]

\n
\n

object

\n

Policy configuration for a user-defined role.

\n
\n
\n
\n
\n
\n

is_single [required]

\n
\n

boolean

\n

Whether this role can only be assigned to one responder at a time.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a user-defined role response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type for a user-defined role.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for the incident type relationship of a user-defined role.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included resources for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "incident_types" + } + } + }, + "type": "incident_user_defined_roles" + } + }, + "json": { + "data": { + "attributes": { + "description": "The technical lead for the incident.", + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "relationships": { + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "incident_types" + } + } + }, + "type": "incident_user_defined_roles" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for creating an incident user-defined role.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an incident user-defined role.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

policy [required]

\n
\n

object

\n

Policy configuration for a user-defined role.

\n
\n
\n
\n
\n
\n

is_single [required]

\n
\n

boolean

\n

Whether this role can only be assigned to one responder at a time.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for creating a user-defined role.

\n
\n
\n
\n
\n
\n

incident_type [required]

\n
\n

object

\n

Relationship to an incident type for a user-defined role.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for the incident type relationship of a user-defined role.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteIncidentUserDefinedRole": { + "responses": { + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentUserDefinedRole": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created": "2024-01-01T00:00:00.000Z", + "description": "The technical lead for the incident.", + "modified": "2024-01-01T00:00:00.000Z", + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "id": "00000000-0000-0000-0000-000000000002", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_user_defined_roles" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined role.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the role was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the role was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

policy [required]

\n
\n

object

\n

Policy configuration for a user-defined role.

\n
\n
\n
\n
\n
\n

is_single [required]

\n
\n

boolean

\n

Whether this role can only be assigned to one responder at a time.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a user-defined role response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type for a user-defined role.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for the incident type relationship of a user-defined role.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included resources for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIncidentUserDefinedRole": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created": "2024-01-01T00:00:00.000Z", + "description": "The technical lead for the incident.", + "modified": "2024-01-01T00:00:00.000Z", + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "id": "00000000-0000-0000-0000-000000000002", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "incident_types" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_user_defined_roles" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident user-defined role.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the role was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the role was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

policy [required]

\n
\n

object

\n

Policy configuration for a user-defined role.

\n
\n
\n
\n
\n
\n

is_single [required]

\n
\n

boolean

\n

Whether this role can only be assigned to one responder at a time.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a user-defined role response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type for a user-defined role.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for the incident type relationship of a user-defined role.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included resources for an incident user-defined role response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "policy": { + "is_single": true + } + }, + "id": "00000000-0000-0000-0000-000000000002", + "type": "incident_user_defined_roles" + } + }, + "json": { + "data": { + "attributes": { + "description": "The technical lead for the incident.", + "name": "Tech Lead", + "policy": { + "is_single": true + } + }, + "id": "00000000-0000-0000-0000-000000000002", + "type": "incident_user_defined_roles" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data for updating an incident user-defined role.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for updating an incident user-defined role.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user-defined role.

\n
\n \n
\n
\n
\n
\n
\n

policy

\n
\n

object

\n

Policy configuration for a user-defined role.

\n
\n
\n
\n
\n
\n

is_single [required]

\n
\n

boolean

\n

Whether this role can only be assigned to one responder at a time.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the user-defined role to update.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident user-defined role resource type. \nAllowed enum values: incident_user_defined_roles

\n
\n \n
\n
\n
\n
" + } + }, + "ImportIncident": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "archived": "2019-09-19T10:00:00.000Z", + "case_id": "integer", + "created": "2025-01-01T00:00:00Z", + "created_by_uuid": "string", + "creation_idempotency_key": "string", + "customer_impact_end": "2019-09-19T10:00:00.000Z", + "customer_impact_scope": "An example customer impact scope", + "customer_impact_start": "2019-09-19T10:00:00.000Z", + "declared": "2025-01-01T00:00:00Z", + "declared_by_uuid": "string", + "detected": "2025-01-01T00:00:00Z", + "fields": { + "": "undefined" + }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", + "is_test": false, + "last_modified_by_uuid": "string", + "modified": "2019-09-19T10:00:00.000Z", + "non_datadog_creator": { + "image_48_px": "string", + "name": "string" + }, + "notification_handles": [ + { + "display_name": "Jane Doe", + "handle": "@test.user@test.com" + } + ], + "public_id": 1, + "resolved": "2019-09-19T10:00:00.000Z", + "severity": "UNKNOWN", + "state": "string", + "title": "A test incident title", + "visibility": "string" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-0000-abcd-1000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "declared_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "impacts": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_impacts" + } + ] + }, + "incident_type": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_types" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-abcd-0001-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "responders": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_responders" + } + ] + }, + "user_defined_fields": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "user_defined_field" + } + ] + } + }, + "type": "incidents" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from an import response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from an import response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case ID.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by_uuid

\n
\n

string

\n

UUID of the user who created the incident.

\n
\n \n
\n
\n
\n
\n
\n

creation_idempotency_key

\n
\n

string

\n

A unique key used to ensure idempotent incident creation.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began to be impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_uuid

\n
\n

string

\n

UUID of the user who last modified the incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that are notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state of the incident.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident that summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from an import response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "title": "Imported incident from external system" + }, + "relationships": { + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "declared_by_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + } + }, + "type": "incidents" + } + }, + "json": { + "data": { + "attributes": { + "declared": "2025-01-01T00:00:00Z", + "detected": "2025-01-01T00:00:00Z", + "fields": { + "": "undefined" + }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", + "resolved": "2025-01-01T01:00:00Z", + "title": "Imported incident from external system", + "visibility": "organization" + }, + "relationships": { + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "declared_by_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + } + }, + "type": "incidents" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data for an import request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The incident's attributes for an import request.

\n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields for which to create initial selections.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents the incident type. If not provided, the default incident type is used.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident was resolved. Can only be set when the state field is set to 'resolved'.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident that summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

enum

\n

The visibility of the incident. \nAllowed enum values: organization,private

default: organization

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships for an incident import request.

\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
" + } + }, + "SearchIncidents": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "facets": { + "commander": [ + { + "count": 5, + "email": "datadog.user@example.com", + "handle": "@datadog.user@example.com", + "name": "Datadog User", + "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" + } + ], + "created_by": [ + { + "count": 5, + "email": "datadog.user@example.com", + "handle": "@datadog.user@example.com", + "name": "Datadog User", + "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" + } + ], + "fields": [ + { + "aggregates": { + "max": 1234, + "min": 20 + }, + "facets": [ + { + "count": 5, + "name": "SEV-2" + } + ], + "name": "Severity" + } + ], + "impact": [ + { + "count": 5, + "name": "SEV-2" + } + ], + "last_modified_by": [ + { + "count": 5, + "email": "datadog.user@example.com", + "handle": "@datadog.user@example.com", + "name": "Datadog User", + "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" + } + ], + "postmortem": [ + { + "count": 5, + "name": "SEV-2" + } + ], + "responder": [ + { + "count": 5, + "email": "datadog.user@example.com", + "handle": "@datadog.user@example.com", + "name": "Datadog User", + "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" + } + ], + "severity": [ + { + "count": 5, + "name": "SEV-2" + } + ], + "state": [ + { + "count": 5, + "name": "SEV-2" + } + ], + "time_to_repair": [ + { + "aggregates": { + "max": 1234, + "min": 20 + }, + "name": "time_to_repair" + } + ], + "time_to_resolve": [ + { + "aggregates": { + "max": 1234, + "min": 20 + }, + "name": "time_to_repair" + } + ] + }, + "incidents": [ + { + "data": { + "attributes": { + "archived": "2019-09-19T10:00:00.000Z", + "case_id": "integer", + "created": "2019-09-19T10:00:00.000Z", + "customer_impact_duration": "integer", + "customer_impact_end": "2019-09-19T10:00:00.000Z", + "customer_impact_scope": "An example customer impact scope", + "customer_impact_start": "2019-09-19T10:00:00.000Z", + "customer_impacted": false, + "declared": "2019-09-19T10:00:00.000Z", + "declared_by": { + "image_48_px": "string", + "name": "string" + }, + "declared_by_uuid": "string", + "detected": "2019-09-19T10:00:00.000Z", + "fields": { + "": "undefined" + }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", + "is_test": false, + "modified": "2019-09-19T10:00:00.000Z", + "non_datadog_creator": { + "image_48_px": "string", + "name": "string" + }, + "notification_handles": [ + { + "display_name": "Jane Doe", + "handle": "@test.user@test.com" + } + ], + "public_id": 1, + "resolved": "2019-09-19T10:00:00.000Z", + "severity": "UNKNOWN", + "state": "string", + "time_to_detect": "integer", + "time_to_internal_response": "integer", + "time_to_repair": "integer", + "time_to_resolve": "integer", + "title": "A test incident title", + "visibility": "string" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-0000-abcd-1000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "declared_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "impacts": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_impacts" + } + ] + }, + "integrations": { + "data": [ + { + "id": "00000000-abcd-0001-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "responders": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_responders" + } + ] + }, + "user_defined_fields": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "user_defined_field" + } + ] + } + }, + "type": "incidents" + } + } + ], + "total": 10 + }, + "type": "incidents_search_results" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ], + "meta": { + "pagination": { + "next_offset": 1000, + "offset": 10, + "size": 1000 + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data returned by an incident search.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes returned by an incident search.

\n
\n
\n
\n
\n
\n

facets [required]

\n
\n

object

\n

Facet data for incidents returned by a search query.

\n
\n
\n
\n
\n
\n

commander

\n
\n

[object]

\n

Facet data for incident commander users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

[object]

\n

Facet data for incident creator users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fields

\n
\n

[object]

\n

Facet data for incident property fields.

\n
\n
\n
\n
\n
\n

aggregates

\n
\n

object

\n

Aggregate information for numeric incident data.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

facets [required]

\n
\n

[object]

\n

Facet data for the property field of an incident.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the incident property field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

impact

\n
\n

[object]

\n

Facet data for incident impact attributes.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

[object]

\n

Facet data for incident last modified by users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

postmortem

\n
\n

[object]

\n

Facet data for incident postmortem existence.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

responder

\n
\n

[object]

\n

Facet data for incident responder users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

severity

\n
\n

[object]

\n

Facet data for incident severity attributes.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

state

\n
\n

[object]

\n

Facet data for incident state attributes.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

[object]

\n

Facet data for incident time to repair metrics.

\n
\n
\n
\n
\n
\n

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the incident property field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

[object]

\n

Facet data for incident time to resolve metrics.

\n
\n
\n
\n
\n
\n

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the incident property field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incidents [required]

\n
\n

[object]

\n

Incidents returned by the search.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

total [required]

\n
\n

int32

\n

Number of incidents returned by the search.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident search result type. \nAllowed enum values: incidents_search_results

default: incidents_search_results

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "DeleteIncident": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncident": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "archived": "2019-09-19T10:00:00.000Z", + "case_id": "integer", + "created": "2019-09-19T10:00:00.000Z", + "customer_impact_duration": "integer", + "customer_impact_end": "2019-09-19T10:00:00.000Z", + "customer_impact_scope": "An example customer impact scope", + "customer_impact_start": "2019-09-19T10:00:00.000Z", + "customer_impacted": false, + "declared": "2019-09-19T10:00:00.000Z", + "declared_by": { + "image_48_px": "string", + "name": "string" + }, + "declared_by_uuid": "string", + "detected": "2019-09-19T10:00:00.000Z", + "fields": { + "": "undefined" + }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", + "is_test": false, + "modified": "2019-09-19T10:00:00.000Z", + "non_datadog_creator": { + "image_48_px": "string", + "name": "string" + }, + "notification_handles": [ + { + "display_name": "Jane Doe", + "handle": "@test.user@test.com" + } + ], + "public_id": 1, + "resolved": "2019-09-19T10:00:00.000Z", + "severity": "UNKNOWN", + "state": "string", + "time_to_detect": "integer", + "time_to_internal_response": "integer", + "time_to_repair": "integer", + "time_to_resolve": "integer", + "title": "A test incident title", + "visibility": "string" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-0000-abcd-1000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "declared_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "impacts": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_impacts" + } + ] + }, + "integrations": { + "data": [ + { + "id": "00000000-abcd-0001-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "responders": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_responders" + } + ] + }, + "user_defined_fields": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "user_defined_field" + } + ] + } + }, + "type": "incidents" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIncident": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "archived": "2019-09-19T10:00:00.000Z", + "case_id": "integer", + "created": "2019-09-19T10:00:00.000Z", + "customer_impact_duration": "integer", + "customer_impact_end": "2019-09-19T10:00:00.000Z", + "customer_impact_scope": "An example customer impact scope", + "customer_impact_start": "2019-09-19T10:00:00.000Z", + "customer_impacted": false, + "declared": "2019-09-19T10:00:00.000Z", + "declared_by": { + "image_48_px": "string", + "name": "string" + }, + "declared_by_uuid": "string", + "detected": "2019-09-19T10:00:00.000Z", + "fields": { + "": "undefined" + }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", + "is_test": false, + "modified": "2019-09-19T10:00:00.000Z", + "non_datadog_creator": { + "image_48_px": "string", + "name": "string" + }, + "notification_handles": [ + { + "display_name": "Jane Doe", + "handle": "@test.user@test.com" + } + ], + "public_id": 1, + "resolved": "2019-09-19T10:00:00.000Z", + "severity": "UNKNOWN", + "state": "string", + "time_to_detect": "integer", + "time_to_internal_response": "integer", + "time_to_repair": "integer", + "time_to_resolve": "integer", + "title": "A test incident title", + "visibility": "string" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-0000-abcd-1000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "declared_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "impacts": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_impacts" + } + ] + }, + "integrations": { + "data": [ + { + "id": "00000000-abcd-0001-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "responders": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "incident_responders" + } + ] + }, + "user_defined_fields": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "user_defined_field" + } + ] + } + }, + "type": "incidents" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "id": "00000000-0000-0000-4567-000000000000", + "relationships": { + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-abcd-0001-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "postmortem": { + "data": { + "id": "00000000-0000-abcd-1000-000000000000", + "type": "incident_postmortems" + } + } + }, + "type": "incidents" + } + }, + "json": { + "data": { + "attributes": { + "customer_impact_end": "2019-09-19T10:00:00.000Z", + "customer_impact_scope": "Example customer impact scope", + "customer_impact_start": "2019-09-19T10:00:00.000Z", + "customer_impacted": false, + "detected": "2019-09-19T10:00:00.000Z", + "fields": { "": "undefined" }, - "incident_type_uuid": "00000000-0000-0000-0000-000000000000", - "resolved": "2025-01-01T01:00:00Z", - "title": "Imported incident from external system", - "visibility": "organization" + "notification_handles": [ + { + "display_name": "Jane Doe", + "handle": "@test.user@test.com" + } + ], + "title": "A test incident title" + }, + "id": "00000000-0000-0000-4567-000000000000", + "relationships": { + "commander_user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-abcd-0001-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "postmortem": { + "data": { + "id": "00000000-0000-abcd-1000-000000000000", + "type": "incident_postmortems" + } + } + }, + "type": "incidents" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data for an update request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes for an update request.

\n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields for which to update selections.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships for an update request.

\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

postmortem

\n
\n

object

\n

A relationship reference for postmortems.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The postmortem relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the postmortem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident postmortem resource type. \nAllowed enum values: incident_postmortems

default: incident_postmortems

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
" + } + }, + "GetIncidentAIPostmortem": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "action_items": "1. Improve failover testing. 2. Add more monitoring alerts.", + "customer_impact": "5% of users experienced timeouts for 30 minutes.", + "executive_summary": "A database failover caused a 30-minute service outage affecting 5% of users.", + "key_insights": "The auto-failover mechanism was slower than expected under high load.", + "key_timeline": "10:00 - Alert fired. 10:05 - On-call engineer paged. 10:30 - Issue resolved.", + "lessons_learned": "We need to test the failover process under realistic load conditions.", + "system_overview": "The primary database cluster experienced a failover event." + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "get_incident_ai_postmortem_response" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AI postmortem data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an AI-generated incident postmortem.

\n
\n
\n
\n
\n
\n

action_items

\n
\n

string

\n

Action items to prevent recurrence.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact

\n
\n

string

\n

The impact of the incident on customers.

\n
\n \n
\n
\n
\n
\n
\n

executive_summary

\n
\n

string

\n

An executive summary of the incident.

\n
\n \n
\n
\n
\n
\n
\n

key_insights

\n
\n

string

\n

Key insights from the incident.

\n
\n \n
\n
\n
\n
\n
\n

key_timeline

\n
\n

string

\n

Key timeline events during the incident.

\n
\n \n
\n
\n
\n
\n
\n

lessons_learned

\n
\n

string

\n

Lessons learned from the incident.

\n
\n \n
\n
\n
\n
\n
\n

system_overview

\n
\n

string

\n

An overview of the affected systems.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AI postmortem response resource type. \nAllowed enum values: get_incident_ai_postmortem_response

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "ListIncidentAttachments": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem", + "modified": "2025-01-01T01:01:01.000000001Z" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of attachment data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentAttachment": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem", + "modified": "2025-01-01T01:01:01.000000001Z" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "incident_attachments" + } + }, + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", + "title": "Postmortem-IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "string", + "type": "incident_attachments" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data for a create request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes for creating an attachment.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object for creating an attachment.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + } + }, + "CreateIncidentPostmortemAttachment": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem", + "modified": "2025-01-01T01:01:01.000000001Z" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": {}, + "type": "incident_attachments" + } + }, + "json": { + "data": { + "attributes": { + "cells": [ + { + "attributes": { + "definition": { + "content": "## Incident Summary\nThis incident was caused by..." + } + }, + "id": "cell-1", + "type": "markdown" + } + ], + "content": "# Incident Report - IR-123\n[...]", + "postmortem_template_id": "93645509-874e-45c4-adfa-623bfeaead89-123", + "title": "Postmortem-IR-123" + }, + "type": "incident_attachments" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Postmortem attachment data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Postmortem attachment attributes

\n
\n
\n
\n
\n
\n

cells

\n
\n

[object]

\n

The cells of the postmortem

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a postmortem cell

\n
\n
\n
\n
\n
\n

definition

\n
\n

object

\n

Definition of a postmortem cell

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

The content of the cell in markdown format

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the cell

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The postmortem cell resource type. \nAllowed enum values: markdown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

The content of the postmortem

\n
\n \n
\n
\n
\n
\n
\n

postmortem_template_id

\n
\n

string

\n

The ID of the postmortem template

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteIncidentAttachment": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIncidentAttachment": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem", + "modified": "2025-01-01T01:01:01.000000001Z" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "incident_attachments" + } + }, + "json": { + "data": { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/124/Postmortem-IR-124", + "title": "Postmortem-IR-124" + } + }, + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_attachments" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data for an update request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes for updating an attachment.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The updated attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The updated URL for the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The updated title for the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + } + }, + "CreatePageFromIncident": { + "responses": { + "200": { + "json": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "page_uuid" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Page UUID data in a response.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the created page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type for a page UUID response. \nAllowed enum values: page_uuid

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "role": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_user_defined_roles" + }, + "target": { + "identifier": "my-team-handle", + "type": "team_uuid" + } + }, + "type": "page" + } + }, + "json": { + "data": { + "attributes": { + "description": "A critical incident affecting production systems.", + "incident_public_id": "12345", + "role": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_user_defined_roles" + }, + "services": [ + "web-store", + "checkout" + ], + "tags": [ + "env:prod" + ], + "target": { + "identifier": "my-team-handle", + "type": "team_uuid" + }, + "title": "Production outage - SEV-1" + }, + "type": "page" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Page data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a page from an incident.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the page.

\n
\n \n
\n
\n
\n
\n
\n

incident_public_id

\n
\n

string

\n

The public ID of the incident.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

object

\n

A reference to an incident role for a page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The role identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of incident role for a page. \nAllowed enum values: incident_user_defined_roles,incident_reserved_roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

services

\n
\n

[string]

\n

List of affected services.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags for the page.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

The target recipient for a page.

\n
\n
\n
\n
\n
\n

identifier [required]

\n
\n

string

\n

The identifier of the target (handle, UUID, or user UUID).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of target for a page request. \nAllowed enum values: team_handle,team_uuid,user_uuid

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type for a page creation request. \nAllowed enum values: page

\n
\n \n
\n
\n
\n
" + } + }, + "UpdateIncidentConfiguration": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2024-01-01T00:00:00.000Z", + "execute_integrations": true, + "execute_notification_rules": true, + "incident_id": "00000000-0000-0000-0000-000000000000", + "include_in_analytics": true, + "include_in_search": true, + "modified_at": "2024-01-01T00:00:00.000Z" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incidents_configurations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident configuration data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident configuration in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

execute_integrations

\n
\n

boolean

\n

Whether integrations are executed for this incident.

\n
\n \n
\n
\n
\n
\n
\n

execute_notification_rules

\n
\n

boolean

\n

Whether notification rules are executed for this incident.

\n
\n \n
\n
\n
\n
\n
\n

incident_id [required]

\n
\n

string

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

include_in_analytics

\n
\n

boolean

\n

Whether this incident is included in analytics.

\n
\n \n
\n
\n
\n
\n
\n

include_in_search

\n
\n

boolean

\n

Whether this incident is included in search results.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The incident configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident configuration.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident configuration resource type. \nAllowed enum values: incidents_configurations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incidents_configurations" + } + }, + "json": { + "data": { + "attributes": { + "execute_integrations": true, + "execute_notification_rules": true, + "include_in_analytics": true, + "include_in_search": true + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "incidents_configurations" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident configuration data in a patch request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for patching an incident configuration. All fields are optional.

\n
\n
\n
\n
\n
\n

execute_integrations

\n
\n

boolean

\n

Whether to execute integrations for this incident.

\n
\n \n
\n
\n
\n
\n
\n

execute_notification_rules

\n
\n

boolean

\n

Whether to execute notification rules for this incident.

\n
\n \n
\n
\n
\n
\n
\n

include_in_analytics

\n
\n

boolean

\n

Whether to include this incident in analytics.

\n
\n \n
\n
\n
\n
\n
\n

include_in_search

\n
\n

boolean

\n

Whether to include this incident in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The incident configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident configuration resource type. \nAllowed enum values: incidents_configurations

\n
\n \n
\n
\n
\n
" + } + }, + "CreateIncidentConfiguration": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2024-01-01T00:00:00.000Z", + "execute_integrations": true, + "execute_notification_rules": true, + "incident_id": "00000000-0000-0000-0000-000000000000", + "include_in_analytics": true, + "include_in_search": true, + "modified_at": "2024-01-01T00:00:00.000Z" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incidents_configurations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident configuration data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident configuration in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was created.

\n
\n \n
\n
\n
\n
\n
\n

execute_integrations

\n
\n

boolean

\n

Whether integrations are executed for this incident.

\n
\n \n
\n
\n
\n
\n
\n

execute_notification_rules

\n
\n

boolean

\n

Whether notification rules are executed for this incident.

\n
\n \n
\n
\n
\n
\n
\n

incident_id [required]

\n
\n

string

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

include_in_analytics

\n
\n

boolean

\n

Whether this incident is included in analytics.

\n
\n \n
\n
\n
\n
\n
\n

include_in_search

\n
\n

boolean

\n

Whether this incident is included in search results.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the configuration was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The incident configuration identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident configuration.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident configuration resource type. \nAllowed enum values: incidents_configurations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "incidents_configurations" + } + }, + "json": { + "data": { + "attributes": { + "execute_integrations": true, + "execute_notification_rules": true, + "include_in_analytics": true, + "include_in_search": true + }, + "type": "incidents_configurations" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident configuration data in a create request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for creating an incident configuration.

\n
\n
\n
\n
\n
\n

execute_integrations

\n
\n

boolean

\n

Whether to execute integrations for this incident.

\n
\n \n
\n
\n
\n
\n
\n

execute_notification_rules

\n
\n

boolean

\n

Whether to execute notification rules for this incident.

\n
\n \n
\n
\n
\n
\n
\n

include_in_analytics

\n
\n

boolean

\n

Whether to include this incident in analytics.

\n
\n \n
\n
\n
\n
\n
\n

include_in_search

\n
\n

boolean

\n

Whether to include this incident in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident configuration resource type. \nAllowed enum values: incidents_configurations

\n
\n \n
\n
\n
\n
" + } + }, + "ListIncidentImpacts": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created": "2025-08-29T13:17:00Z", + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" + ] + }, + "impact_type": "customer", + "modified": "2025-08-29T13:17:00Z", + "start_at": "2025-08-28T13:17:00Z" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_impacts" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident impact's attributes.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the impact was created.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

impact_type

\n
\n

string

\n

The type of impact.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the impact was last modified.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp representing when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident impact's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident impact's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateIncidentImpact": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created": "2025-08-29T13:17:00Z", + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" + ] + }, + "impact_type": "customer", + "modified": "2025-08-29T13:17:00Z", + "start_at": "2025-08-28T13:17:00Z" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_impacts" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident impact's attributes.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the impact was created.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

impact_type

\n
\n

string

\n

The type of impact.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the impact was last modified.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp representing when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident impact's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident impact's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "description": "Service was unavailable for external users", + "start_at": "2025-08-28T13:17:00Z" }, - "relationships": { - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } + "type": "incident_impacts" + } + }, + "json": { + "data": { + "attributes": { + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" + ] }, - "declared_by_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - } + "start_at": "2025-08-28T13:17:00Z" }, - "type": "incidents" + "type": "incident_impacts" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data for an import request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The incident's attributes for an import request.

\n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields for which to create initial selections.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents the incident type. If not provided, the default incident type is used.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident was resolved. Can only be set when the state field is set to 'resolved'.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident that summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

enum

\n

The visibility of the incident. \nAllowed enum values: organization,private

default: organization

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships for an incident import request.

\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The incident impact's attributes for a create request.

\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
" } }, - "SearchIncidents": { + "DeleteIncidentImpact": { + "responses": { + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "PatchIncidentImpact": { "responses": { "200": { "json": { "data": { "attributes": { - "facets": { - "commander": [ - { - "count": 5, - "email": "datadog.user@example.com", - "handle": "@datadog.user@example.com", - "name": "Datadog User", - "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" - } - ], - "created_by": [ - { - "count": 5, - "email": "datadog.user@example.com", - "handle": "@datadog.user@example.com", - "name": "Datadog User", - "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" - } - ], - "fields": [ - { - "aggregates": { - "max": 1234, - "min": 20 - }, - "facets": [ - { - "count": 5, - "name": "SEV-2" - } - ], - "name": "Severity" - } - ], - "impact": [ - { - "count": 5, - "name": "SEV-2" - } - ], - "last_modified_by": [ - { - "count": 5, - "email": "datadog.user@example.com", - "handle": "@datadog.user@example.com", - "name": "Datadog User", - "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" - } - ], - "postmortem": [ - { - "count": 5, - "name": "SEV-2" - } - ], - "responder": [ - { - "count": 5, - "email": "datadog.user@example.com", - "handle": "@datadog.user@example.com", - "name": "Datadog User", - "uuid": "773b045d-ccf8-4808-bd3b-955ef6a8c940" - } - ], - "severity": [ - { - "count": 5, - "name": "SEV-2" - } - ], - "state": [ - { - "count": 5, - "name": "SEV-2" - } - ], - "time_to_repair": [ - { - "aggregates": { - "max": 1234, - "min": 20 - }, - "name": "time_to_repair" - } - ], - "time_to_resolve": [ - { - "aggregates": { - "max": 1234, - "min": 20 - }, - "name": "time_to_repair" - } + "created": "2025-08-29T13:17:00Z", + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" + ] + }, + "impact_type": "customer", + "modified": "2025-08-29T13:17:00Z", + "start_at": "2025-08-28T13:17:00Z" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_impacts" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident impact's attributes.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the impact was created.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

impact_type

\n
\n

string

\n

The type of impact.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the impact was last modified.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp representing when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident impact's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident impact's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "description": "Service was unavailable for external users", + "start_at": "2025-08-28T13:17:00Z" + }, + "type": "incident_impacts" + } + }, + "json": { + "data": { + "attributes": { + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" + ] + }, + "start_at": "2025-08-28T13:17:00Z" + }, + "type": "incident_impacts" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The incident impact's attributes for a create request.

\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
" + } + }, + "UpdateIncidentImpact": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created": "2025-08-29T13:17:00Z", + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" ] }, - "incidents": [ - { - "data": { - "attributes": { - "archived": "2019-09-19T10:00:00.000Z", - "case_id": "integer", - "created": "2019-09-19T10:00:00.000Z", - "customer_impact_duration": "integer", - "customer_impact_end": "2019-09-19T10:00:00.000Z", - "customer_impact_scope": "An example customer impact scope", - "customer_impact_start": "2019-09-19T10:00:00.000Z", - "customer_impacted": false, - "declared": "2019-09-19T10:00:00.000Z", - "declared_by": { - "image_48_px": "string", - "name": "string" - }, - "declared_by_uuid": "string", - "detected": "2019-09-19T10:00:00.000Z", - "fields": { - "": "undefined" - }, - "incident_type_uuid": "00000000-0000-0000-0000-000000000000", - "is_test": false, - "modified": "2019-09-19T10:00:00.000Z", - "non_datadog_creator": { - "image_48_px": "string", - "name": "string" - }, - "notification_handles": [ - { - "display_name": "Jane Doe", - "handle": "@test.user@test.com" - } - ], - "public_id": 1, - "resolved": "2019-09-19T10:00:00.000Z", - "severity": "UNKNOWN", - "state": "string", - "time_to_detect": "integer", - "time_to_internal_response": "integer", - "time_to_repair": "integer", - "time_to_resolve": "integer", - "title": "A test incident title", - "visibility": "string" - }, - "id": "00000000-0000-0000-1234-000000000000", - "relationships": { - "attachments": { - "data": [ - { - "id": "00000000-0000-abcd-1000-000000000000", - "type": "incident_attachments" - } - ] - }, - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - }, - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "declared_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "impacts": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_impacts" - } - ] - }, - "integrations": { - "data": [ - { - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "responders": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_responders" - } - ] - }, - "user_defined_fields": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "user_defined_field" - } - ] - } - }, - "type": "incidents" - } + "impact_type": "customer", + "modified": "2025-08-29T13:17:00Z", + "start_at": "2025-08-28T13:17:00Z" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" } - ], - "total": 10 + }, + "incident": { + "data": { + "id": "00000000-0000-0000-1234-000000000000", + "type": "incidents" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } }, - "type": "incidents_search_results" + "type": "incident_impacts" }, "included": [ { @@ -4392,16 +8229,91 @@ "id": "string", "type": "users" } - ], - "meta": { - "pagination": { - "next_offset": 1000, - "offset": 10, - "size": 1000 - } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident impact's attributes.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the impact was created.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

impact_type

\n
\n

string

\n

The type of impact.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the impact was last modified.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp representing when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident impact's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident impact's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "description": "Service was unavailable for external users", + "start_at": "2025-08-28T13:17:00Z" + }, + "type": "incident_impacts" + } + }, + "json": { + "data": { + "attributes": { + "description": "Service was unavailable for external users", + "end_at": "2025-08-29T13:17:00Z", + "fields": { + "customers_impacted": "all", + "products_impacted": [ + "shopping", + "marketing" + ] + }, + "start_at": "2025-08-28T13:17:00Z" + }, + "type": "incident_impacts" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The incident impact's attributes for a create request.

\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
" + } + }, + "CreateOnCallPageFromIncident": { + "responses": { + "200": { + "json": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "page_uuid" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data returned by an incident search.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes returned by an incident search.

\n
\n
\n
\n
\n
\n

facets [required]

\n
\n

object

\n

Facet data for incidents returned by a search query.

\n
\n
\n
\n
\n
\n

commander

\n
\n

[object]

\n

Facet data for incident commander users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

[object]

\n

Facet data for incident creator users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fields

\n
\n

[object]

\n

Facet data for incident property fields.

\n
\n
\n
\n
\n
\n

aggregates

\n
\n

object

\n

Aggregate information for numeric incident data.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

facets [required]

\n
\n

[object]

\n

Facet data for the property field of an incident.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the incident property field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

impact

\n
\n

[object]

\n

Facet data for incident impact attributes.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

[object]

\n

Facet data for incident last modified by users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

postmortem

\n
\n

[object]

\n

Facet data for incident postmortem existence.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

responder

\n
\n

[object]

\n

Facet data for incident responder users.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

severity

\n
\n

[object]

\n

Facet data for incident severity attributes.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

state

\n
\n

[object]

\n

Facet data for incident state attributes.

\n
\n
\n
\n
\n
\n

count

\n
\n

int32

\n

Count of the facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The facet value appearing in search results.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

[object]

\n

Facet data for incident time to repair metrics.

\n
\n
\n
\n
\n
\n

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the incident property field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

[object]

\n

Facet data for incident time to resolve metrics.

\n
\n
\n
\n
\n
\n

aggregates [required]

\n
\n

object

\n

Aggregate information for numeric incident data.

\n
\n
\n
\n
\n
\n

max

\n
\n

double

\n

Maximum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n

min

\n
\n

double

\n

Minimum value of the numeric aggregates.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the incident property field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incidents [required]

\n
\n

[object]

\n

Incidents returned by the search.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

total [required]

\n
\n

int32

\n

Number of incidents returned by the search.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident search result type. \nAllowed enum values: incidents_search_results

default: incidents_search_results

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Page UUID data in a response.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the created page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type for a page UUID response. \nAllowed enum values: page_uuid

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -4445,13 +8357,143 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "attributes": { + "role": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_user_defined_roles" + }, + "target": { + "identifier": "my-team-handle", + "type": "team_uuid" + } + }, + "type": "page" + } + }, + "json": { + "data": { + "attributes": { + "description": "A critical incident affecting production systems.", + "role": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_user_defined_roles" + }, + "services": [ + "web-store" + ], + "tags": [ + "env:prod" + ], + "target": { + "identifier": "my-team-handle", + "type": "team_uuid" + }, + "title": "Production outage - SEV-1" + }, + "type": "page" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

On-call page data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating an on-call page from an incident.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the page.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

object

\n

A reference to an incident role for a page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The role identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of incident role for a page. \nAllowed enum values: incident_user_defined_roles,incident_reserved_roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

services

\n
\n

[string]

\n

List of affected services.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags for the page.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

The target recipient for a page.

\n
\n
\n
\n
\n
\n

identifier [required]

\n
\n

string

\n

The identifier of the target (handle, UUID, or user UUID).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of target for a page request. \nAllowed enum values: team_handle,team_uuid,user_uuid

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type for a page creation request. \nAllowed enum values: page

\n
\n \n
\n
\n
\n
" } }, - "DeleteIncident": { + "LinkPageToIncident": { "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created": "2019-09-19T10:00:00.000Z", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" + } + ] + }, + "modified": "2019-09-19T10:00:00.000Z", + "status": "integer" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_integrations" + }, + "included": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false + }, + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, "400": { "json": { "errors": [ @@ -4484,6 +8526,24 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, + "409": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, "429": { "json": { "errors": [ @@ -4494,143 +8554,139 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "attributes": { + "page_target": { + "identifier": "my-oncall-team", + "type": "team_handle" + } + }, + "id": "PAGE-12345", + "type": "page" + } + }, + "json": { + "data": { + "attributes": { + "key": "PAGE-12345", + "page_target": { + "identifier": "my-oncall-team", + "type": "team_handle" + }, + "team_id": "team-abc-123" + }, + "id": "PAGE-12345", + "type": "page" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

On-call page data in a link request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for linking a page to an incident.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The key of the on-call page.

\n
\n \n
\n
\n
\n
\n
\n

page_target

\n
\n

object

\n

The target of an on-call page.

\n
\n
\n
\n
\n
\n

identifier [required]

\n
\n

string

\n

The identifier of the page target.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the page target.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

The team ID associated with the page (deprecated, use page_target instead).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the on-call page to link.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

On-call page resource type. \nAllowed enum values: page

\n
\n \n
\n
\n
\n
" } }, - "GetIncident": { + "ListIncidentIntegrations": { "responses": { "200": { "json": { - "data": { - "attributes": { - "archived": "2019-09-19T10:00:00.000Z", - "case_id": "integer", - "created": "2019-09-19T10:00:00.000Z", - "customer_impact_duration": "integer", - "customer_impact_end": "2019-09-19T10:00:00.000Z", - "customer_impact_scope": "An example customer impact scope", - "customer_impact_start": "2019-09-19T10:00:00.000Z", - "customer_impacted": false, - "declared": "2019-09-19T10:00:00.000Z", - "declared_by": { - "image_48_px": "string", - "name": "string" - }, - "declared_by_uuid": "string", - "detected": "2019-09-19T10:00:00.000Z", - "fields": { - "": "undefined" - }, - "incident_type_uuid": "00000000-0000-0000-0000-000000000000", - "is_test": false, - "modified": "2019-09-19T10:00:00.000Z", - "non_datadog_creator": { - "image_48_px": "string", - "name": "string" - }, - "notification_handles": [ - { - "display_name": "Jane Doe", - "handle": "@test.user@test.com" - } - ], - "public_id": 1, - "resolved": "2019-09-19T10:00:00.000Z", - "severity": "UNKNOWN", - "state": "string", - "time_to_detect": "integer", - "time_to_internal_response": "integer", - "time_to_repair": "integer", - "time_to_resolve": "integer", - "title": "A test incident title", - "visibility": "string" - }, - "id": "00000000-0000-0000-1234-000000000000", - "relationships": { - "attachments": { - "data": [ - { - "id": "00000000-0000-abcd-1000-000000000000", - "type": "incident_attachments" - } - ] - }, - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - }, - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "declared_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } + "data": [ + { + "attributes": { + "created": "2019-09-19T10:00:00.000Z", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" + } + ] + }, + "modified": "2019-09-19T10:00:00.000Z", + "status": "integer" }, - "impacts": { - "data": [ - { + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_impacts" - } - ] - }, - "integrations": { - "data": [ - { - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_integrations" + "type": "users" } - ] - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "responders": { - "data": [ - { + }, + "last_modified_by_user": { + "data": { "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_responders" + "type": "users" } - ] + } }, - "user_defined_fields": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "user_defined_field" - } - ] - } - }, - "type": "incidents" - }, + "type": "incident_integrations" + } + ], "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } - ] + ], + "meta": { + "pagination": { + "next_offset": 1000, + "offset": 10, + "size": 1000 + } + } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident integration metadata.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4679,138 +8735,101 @@ "html": "" } }, - "UpdateIncident": { + "CreateIncidentIntegration": { "responses": { - "200": { + "201": { "json": { "data": { "attributes": { - "archived": "2019-09-19T10:00:00.000Z", - "case_id": "integer", "created": "2019-09-19T10:00:00.000Z", - "customer_impact_duration": "integer", - "customer_impact_end": "2019-09-19T10:00:00.000Z", - "customer_impact_scope": "An example customer impact scope", - "customer_impact_start": "2019-09-19T10:00:00.000Z", - "customer_impacted": false, - "declared": "2019-09-19T10:00:00.000Z", - "declared_by": { - "image_48_px": "string", - "name": "string" - }, - "declared_by_uuid": "string", - "detected": "2019-09-19T10:00:00.000Z", - "fields": { - "": "undefined" + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" + } + ] }, - "incident_type_uuid": "00000000-0000-0000-0000-000000000000", - "is_test": false, "modified": "2019-09-19T10:00:00.000Z", - "non_datadog_creator": { - "image_48_px": "string", - "name": "string" - }, - "notification_handles": [ - { - "display_name": "Jane Doe", - "handle": "@test.user@test.com" - } - ], - "public_id": 1, - "resolved": "2019-09-19T10:00:00.000Z", - "severity": "UNKNOWN", - "state": "string", - "time_to_detect": "integer", - "time_to_internal_response": "integer", - "time_to_repair": "integer", - "time_to_resolve": "integer", - "title": "A test incident title", - "visibility": "string" + "status": "integer" }, "id": "00000000-0000-0000-1234-000000000000", "relationships": { - "attachments": { - "data": [ - { - "id": "00000000-0000-abcd-1000-000000000000", - "type": "incident_attachments" - } - ] - }, - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - }, "created_by_user": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, - "declared_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "impacts": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_impacts" - } - ] - }, - "integrations": { - "data": [ - { - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_integrations" - } - ] - }, "last_modified_by_user": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } - }, - "responders": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "incident_responders" - } - ] - }, - "user_defined_fields": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "user_defined_field" - } - ] } }, - "type": "incidents" + "type": "incident_integrations" }, "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false + }, + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } }, - "id": "string", "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes from a response.

\n
\n
\n
\n
\n
\n

archived

\n
\n

date-time

\n

Timestamp of when the incident was archived.

\n
\n \n
\n
\n
\n
\n
\n

case_id

\n
\n

int64

\n

The incident case id.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident was created.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_duration

\n
\n

int64

\n

Length of the incident's customer impact in seconds.\nEquals the difference between customer_impact_start and customer_impact_end.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

declared

\n
\n

date-time

\n

Timestamp when the incident was declared.

\n
\n \n
\n
\n
\n
\n
\n

declared_by

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

declared_by_uuid

\n
\n

string

\n

UUID of the user who declared the incident.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields attached to incidents.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type_uuid

\n
\n

string

\n

A unique identifier that represents an incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_test

\n
\n

boolean

\n

A flag indicating whether the incident is a test incident.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident was last modified.

\n
\n \n
\n
\n
\n
\n
\n

non_datadog_creator

\n
\n

object

\n

Incident's non Datadog creator.

\n
\n
\n
\n
\n
\n

image_48_px

\n
\n

string

\n

Non Datadog creator 48px image.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Non Datadog creator name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

int64

\n

The monotonically increasing integer ID for the incident.

\n
\n \n
\n
\n
\n
\n
\n

resolved

\n
\n

date-time

\n

Timestamp when the incident's state was last changed from active or stable to resolved or completed.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

enum

\n

The incident severity. \nAllowed enum values: UNKNOWN,SEV-0,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

string

\n

The state incident.

\n
\n \n
\n
\n
\n
\n
\n

time_to_detect

\n
\n

int64

\n

The amount of time in seconds to detect the incident.\nEquals the difference between customer_impact_start and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_internal_response

\n
\n

int64

\n

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

\n
\n \n
\n
\n
\n
\n
\n

time_to_repair

\n
\n

int64

\n

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

\n
\n \n
\n
\n
\n
\n
\n

time_to_resolve

\n
\n

int64

\n

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n

visibility

\n
\n

string

\n

The incident visibility status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

attachments

\n
\n

object

\n

A relationship reference for attachments.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

declared_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

impacts

\n
\n

object

\n

Relationship to impacts.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the impact.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident impacts type. \nAllowed enum values: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Relationship to incident responders.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident responders type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_defined_fields

\n
\n

object

\n

Relationship to incident user defined fields.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of user defined fields.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident user defined fields type. \nAllowed enum values: user_defined_field

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4856,129 +8875,214 @@ "request": { "json_curl": { "data": { - "id": "00000000-0000-0000-4567-000000000000", - "relationships": { - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - }, - "integrations": { - "data": [ + "attributes": { + "integration_type": 1, + "metadata": { + "channels": [ { - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_integrations" + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" } ] - }, - "postmortem": { - "data": { - "id": "00000000-0000-abcd-1000-000000000000", - "type": "incident_postmortems" - } } }, - "type": "incidents" + "type": "incident_integrations" } }, "json": { "data": { "attributes": { - "customer_impact_end": "2019-09-19T10:00:00.000Z", - "customer_impact_scope": "Example customer impact scope", - "customer_impact_start": "2019-09-19T10:00:00.000Z", - "customer_impacted": false, - "detected": "2019-09-19T10:00:00.000Z", - "fields": { - "": "undefined" - }, - "notification_handles": [ - { - "display_name": "Jane Doe", - "handle": "@test.user@test.com" - } - ], - "title": "A test incident title" - }, - "id": "00000000-0000-0000-4567-000000000000", - "relationships": { - "commander_user": { - "data": { - "id": "00000000-0000-0000-0000-000000000000", - "type": "users" - } - }, - "integrations": { - "data": [ + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ { - "id": "00000000-abcd-0001-0000-000000000000", - "type": "incident_integrations" + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" } ] }, - "postmortem": { - "data": { - "id": "00000000-0000-abcd-1000-000000000000", - "type": "incident_postmortems" - } - } + "status": "integer" }, - "type": "incidents" + "type": "incident_integrations" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data for an update request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident's attributes for an update request.

\n
\n
\n
\n
\n
\n

customer_impact_end

\n
\n

date-time

\n

Timestamp when customers were no longer impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_scope

\n
\n

string

\n

A summary of the impact customers experienced during the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impact_start

\n
\n

date-time

\n

Timestamp when customers began being impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

customer_impacted

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\n
\n \n
\n
\n
\n
\n
\n

detected

\n
\n

date-time

\n

Timestamp when the incident was detected.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

A condensed view of the user-defined fields for which to update selections.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

 <oneOf>

\n

Dynamic fields for which selections can be made, with field names as keys.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A field with a single value selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the single value field definitions. \nAllowed enum values: dropdown,textbox

default: dropdown

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

The single value selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A field with potentially multiple values selected.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the multiple value field definitions. \nAllowed enum values: multiselect,textarray,metrictag,autocomplete

default: multiselect

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

[string]

\n

The multiple values selected for this field.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_handles

\n
\n

[object]

\n

Notification handles that will be notified of the incident during update.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

The name of the notified handle.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle used for the notification. This includes an email address, Slack channel, or workflow.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the incident, which summarizes what happened.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships for an update request.

\n
\n
\n
\n
\n
\n

commander_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A relationship reference for multiple integration metadata objects.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Integration metadata relationship array

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the integration metadata.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

postmortem

\n
\n

object

\n

A relationship reference for postmortems.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The postmortem relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the postmortem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident postmortem resource type. \nAllowed enum values: incident_postmortems

default: incident_postmortems

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentAttachments": { + "DeleteIncidentIntegration": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentIntegration": { "responses": { "200": { "json": { - "data": [ - { - "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem", - "modified": "2025-01-01T01:01:01.000000001Z" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "incident": { - "data": { - "id": "00000000-0000-0000-1234-000000000000", - "type": "incidents" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" + "data": { + "attributes": { + "created": "2019-09-19T10:00:00.000Z", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" } + ] + }, + "modified": "2019-09-19T10:00:00.000Z", + "status": "integer" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" } }, - "type": "incident_attachments" - } - ], + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_integrations" + }, "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of attachment data objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, - "400": { + "404": { "json": { "errors": [ "Bad Request" @@ -5001,25 +9105,34 @@ "html": "" } }, - "CreateIncidentAttachment": { + "UpdateIncidentIntegration": { "responses": { - "201": { + "200": { "json": { "data": { "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", - "title": "Postmortem IR-123" + "created": "2019-09-19T10:00:00.000Z", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" + } + ] }, - "attachment_type": "postmortem", - "modified": "2025-01-01T01:01:01.000000001Z" + "modified": "2019-09-19T10:00:00.000Z", + "status": "integer" }, - "id": "00000000-abcd-0002-0000-000000000000", + "id": "00000000-0000-0000-1234-000000000000", "relationships": { - "incident": { + "created_by_user": { "data": { - "id": "00000000-0000-0000-1234-000000000000", - "type": "incidents" + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" } }, "last_modified_by_user": { @@ -5029,23 +9142,64 @@ } } }, - "type": "incident_attachments" + "type": "incident_integrations" }, "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -5055,6 +9209,14 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, "403": { "json": { "errors": [ @@ -5063,6 +9225,14 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, "429": { "json": { "errors": [ @@ -5075,132 +9245,156 @@ "request": { "json_curl": { "data": { - "type": "incident_attachments" + "attributes": { + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" + } + ] + } + }, + "type": "incident_integrations" } }, "json": { "data": { "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", - "title": "Postmortem-IR-123" + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "integration_type": 1, + "metadata": { + "channels": [ + { + "channel_id": "C0123456789", + "channel_name": "#example-channel-name", + "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "team_id": "T01234567" + } + ] }, - "attachment_type": "postmortem" + "status": "integer" }, - "id": "string", - "type": "incident_attachments" + "type": "incident_integrations" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data for a create request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes for creating an attachment.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object for creating an attachment.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata data for a patch request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
" } }, - "CreateIncidentPostmortemAttachment": { + "ListIncidentTodos": { "responses": { - "201": { + "200": { "json": { - "data": { - "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", - "title": "Postmortem IR-123" + "data": [ + { + "attributes": { + "assignees": [ + { + "description": "@test.user@test.com", + "example": "@test.user@test.com", + "type": "@test.user@test.com" + } + ], + "completed": "2023-03-06T22:00:00.000000+00:00", + "content": "Restore lost data.", + "created": "2019-09-19T10:00:00.000Z", + "due_date": "2023-07-10T05:00:00.000000+00:00", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "modified": "2019-09-19T10:00:00.000Z" }, - "attachment_type": "postmortem", - "modified": "2025-01-01T01:01:01.000000001Z" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "incident": { - "data": { - "id": "00000000-0000-0000-1234-000000000000", - "type": "incidents" + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } } }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, + "type": "incident_todos" + } + ], "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } - ] - }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" - }, - "400": { - "json": { - "errors": [ - { - "detail": "Missing required attribute in body", - "meta": {}, - "source": { - "header": "Authorization", - "parameter": "limit", - "pointer": "/data/attributes/title" - }, - "status": "400", - "title": "Bad Request" + ], + "meta": { + "pagination": { + "next_offset": 1000, + "offset": 10, + "size": 1000 } - ] + } }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident todos.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, - "429": { + "400": { "json": { "errors": [ "Bad Request" ] }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, - "request": { - "json_curl": { - "data": { - "attributes": {}, - "type": "incident_attachments" - } - }, - "json": { - "data": { - "attributes": { - "cells": [ - { - "attributes": { - "definition": { - "content": "## Incident Summary\nThis incident was caused by..." - } - }, - "id": "cell-1", - "type": "markdown" - } - ], - "content": "# Incident Report - IR-123\n[...]", - "postmortem_template_id": "93645509-874e-45c4-adfa-623bfeaead89-123", - "title": "Postmortem-IR-123" - }, - "type": "incident_attachments" - } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Postmortem attachment data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Postmortem attachment attributes

\n
\n
\n
\n
\n
\n

cells

\n
\n

[object]

\n

The cells of the postmortem

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a postmortem cell

\n
\n
\n
\n
\n
\n

definition

\n
\n

object

\n

Definition of a postmortem cell

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

The content of the cell in markdown format

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the cell

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The postmortem cell resource type. \nAllowed enum values: markdown

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

The content of the postmortem

\n
\n \n
\n
\n
\n
\n
\n

postmortem_template_id

\n
\n

string

\n

The ID of the postmortem template

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" - } - }, - "DeleteIncidentAttachment": { - "responses": { - "400": { + "401": { "json": { "errors": [ "Bad Request" @@ -5239,25 +9433,32 @@ "html": "" } }, - "UpdateIncidentAttachment": { + "CreateIncidentTodo": { "responses": { - "200": { + "201": { "json": { "data": { "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123/Postmortem-IR-123", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem", - "modified": "2025-01-01T01:01:01.000000001Z" + "assignees": [ + { + "description": "@test.user@test.com", + "example": "@test.user@test.com", + "type": "@test.user@test.com" + } + ], + "completed": "2023-03-06T22:00:00.000000+00:00", + "content": "Restore lost data.", + "created": "2019-09-19T10:00:00.000Z", + "due_date": "2023-07-10T05:00:00.000000+00:00", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "modified": "2019-09-19T10:00:00.000Z" }, - "id": "00000000-abcd-0002-0000-000000000000", + "id": "00000000-0000-0000-1234-000000000000", "relationships": { - "incident": { + "created_by_user": { "data": { - "id": "00000000-0000-0000-1234-000000000000", - "type": "incidents" + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" } }, "last_modified_by_user": { @@ -5267,23 +9468,64 @@ } } }, - "type": "incident_attachments" + "type": "incident_todos" }, "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data from a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attachment's attributes.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The URL of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type

\n
\n

enum

\n

The type of the attachment. \nAllowed enum values: postmortem,link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the attachment was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The attachment's resource relationships.

\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

A list of related objects included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -5293,6 +9535,14 @@ }, "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, "403": { "json": { "errors": [ @@ -5321,84 +9571,178 @@ "request": { "json_curl": { "data": { - "type": "incident_attachments" + "attributes": { + "assignees": [ + {} + ], + "content": "Restore lost data." + }, + "type": "incident_todos" } }, "json": { "data": { "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/124/Postmortem-IR-124", - "title": "Postmortem-IR-124" - } + "assignees": [ + { + "description": "@test.user@test.com", + "example": "@test.user@test.com", + "type": "@test.user@test.com" + } + ], + "completed": "2023-03-06T22:00:00.000000+00:00", + "content": "Restore lost data.", + "due_date": "2023-07-10T05:00:00.000000+00:00", + "incident_id": "00000000-aaaa-0000-0000-000000000000" }, - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_attachments" + "type": "incident_todos" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Attachment data for an update request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes for updating an attachment.

\n
\n
\n
\n
\n
\n

attachment

\n
\n

object

\n

The updated attachment object.

\n
\n
\n
\n
\n
\n

documentUrl

\n
\n

string

\n

The updated URL for the attachment.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The updated title for the attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the attachment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentImpacts": { + "DeleteIncidentTodo": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetIncidentTodo": { "responses": { "200": { "json": { - "data": [ - { - "attributes": { - "created": "2025-08-29T13:17:00Z", - "description": "Service was unavailable for external users", - "end_at": "2025-08-29T13:17:00Z", - "fields": { - "customers_impacted": "all", - "products_impacted": [ - "shopping", - "marketing" - ] - }, - "impact_type": "customer", - "modified": "2025-08-29T13:17:00Z", - "start_at": "2025-08-28T13:17:00Z" - }, - "id": "00000000-0000-0000-1234-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "incident": { - "data": { - "id": "00000000-0000-0000-1234-000000000000", - "type": "incidents" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } + "data": { + "attributes": { + "assignees": [ + { + "description": "@test.user@test.com", + "example": "@test.user@test.com", + "type": "@test.user@test.com" + } + ], + "completed": "2023-03-06T22:00:00.000000+00:00", + "content": "Restore lost data.", + "created": "2019-09-19T10:00:00.000Z", + "due_date": "2023-07-10T05:00:00.000000+00:00", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "modified": "2019-09-19T10:00:00.000Z" + }, + "id": "00000000-0000-0000-1234-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" } }, - "type": "incident_impacts" - } - ], + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incident_todos" + }, "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident impacts.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident impact's attributes.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the impact was created.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

impact_type

\n
\n

string

\n

The type of impact.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the impact was last modified.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp representing when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident impact's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident impact's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -5447,25 +9791,25 @@ "html": "" } }, - "CreateIncidentImpact": { + "UpdateIncidentTodo": { "responses": { - "201": { + "200": { "json": { "data": { "attributes": { - "created": "2025-08-29T13:17:00Z", - "description": "Service was unavailable for external users", - "end_at": "2025-08-29T13:17:00Z", - "fields": { - "customers_impacted": "all", - "products_impacted": [ - "shopping", - "marketing" - ] - }, - "impact_type": "customer", - "modified": "2025-08-29T13:17:00Z", - "start_at": "2025-08-28T13:17:00Z" + "assignees": [ + { + "description": "@test.user@test.com", + "example": "@test.user@test.com", + "type": "@test.user@test.com" + } + ], + "completed": "2023-03-06T22:00:00.000000+00:00", + "content": "Restore lost data.", + "created": "2019-09-19T10:00:00.000Z", + "due_date": "2023-07-10T05:00:00.000000+00:00", + "incident_id": "00000000-aaaa-0000-0000-000000000000", + "modified": "2019-09-19T10:00:00.000Z" }, "id": "00000000-0000-0000-1234-000000000000", "relationships": { @@ -5475,12 +9819,6 @@ "type": "users" } }, - "incident": { - "data": { - "id": "00000000-0000-0000-1234-000000000000", - "type": "incidents" - } - }, "last_modified_by_user": { "data": { "id": "00000000-0000-0000-2345-000000000000", @@ -5488,23 +9826,64 @@ } } }, - "type": "incident_impacts" + "type": "incident_todos" }, "included": [ { "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "uuid": "string" + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false }, "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident impact's attributes.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the impact was created.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

impact_type

\n
\n

string

\n

The type of impact.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the impact was last modified.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp representing when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident impact's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident impact's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident

\n
\n

object

\n

Relationship to incident.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -5551,177 +9930,97 @@ "json_curl": { "data": { "attributes": { - "description": "Service was unavailable for external users", - "start_at": "2025-08-28T13:17:00Z" + "assignees": [ + {} + ], + "content": "Restore lost data." }, - "type": "incident_impacts" + "type": "incident_todos" } }, "json": { "data": { "attributes": { - "description": "Service was unavailable for external users", - "end_at": "2025-08-29T13:17:00Z", - "fields": { - "customers_impacted": "all", - "products_impacted": [ - "shopping", - "marketing" - ] - }, - "start_at": "2025-08-28T13:17:00Z" + "assignees": [ + { + "description": "@test.user@test.com", + "example": "@test.user@test.com", + "type": "@test.user@test.com" + } + ], + "completed": "2023-03-06T22:00:00.000000+00:00", + "content": "Restore lost data.", + "due_date": "2023-07-10T05:00:00.000000+00:00", + "incident_id": "00000000-aaaa-0000-0000-000000000000" }, - "type": "incident_impacts" + "type": "incident_todos" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident impact data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The incident impact's attributes for a create request.

\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

Description of the impact.

\n
\n \n
\n
\n
\n
\n
\n

end_at

\n
\n

date-time

\n

Timestamp when the impact ended.

\n
\n \n
\n
\n
\n
\n
\n

fields

\n
\n

object

\n

An object mapping impact field names to field values.

\n
\n \n
\n
\n
\n
\n
\n

start_at [required]

\n
\n

date-time

\n

Timestamp when the impact started.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident impact resource type. \nAllowed enum values: incident_impacts

default: incident_impacts

\n
\n \n
\n
\n
\n
" - } - }, - "DeleteIncidentImpact": { - "responses": { - "401": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "403": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "404": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "429": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, - "request": { - "json_curl": {}, - "json": {}, - "html": "" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo data for a patch request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentIntegrations": { + "ListIncidentResponders": { "responses": { "200": { "json": { "data": [ { "attributes": { - "created": "2019-09-19T10:00:00.000Z", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "team_id": "T01234567" - } - ] - }, - "modified": "2019-09-19T10:00:00.000Z", - "status": "integer" + "created": "2024-01-01T00:00:00.000Z", + "external_id": null, + "external_source": null, + "is_billable": true, + "last_active": "2024-01-01T00:00:00.000Z", + "meta": {}, + "modified": "2024-01-01T00:00:00.000Z" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { - "created_by_user": { + "created_by": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "last_modified_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, - "last_modified_by_user": { + "role_assignments": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_role_assignments" + } + ] + }, + "user": { "data": { - "id": "00000000-0000-0000-2345-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "type": "users" } } }, - "type": "incident_integrations" + "type": "incident_responders" } ], "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } - ], - "meta": { - "pagination": { - "next_offset": 1000, - "offset": 10, - "size": 1000 - } - } + ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident integration metadata.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of incident responders.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident responder in a response.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the responder was created.

\n
\n \n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

The external ID of the responder.

\n
\n \n
\n
\n
\n
\n
\n

external_source

\n
\n

string

\n

The external source of the responder.

\n
\n \n
\n
\n
\n
\n
\n

is_billable [required]

\n
\n

boolean

\n

Whether this responder counts toward billing.

\n
\n \n
\n
\n
\n
\n
\n

last_active

\n
\n

date-time

\n

Timestamp when the responder was last active.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional metadata for the responder.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the responder was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The responder identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident responder.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

role_assignments

\n
\n

object

\n

Relationship to role assignments for a responder.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of role assignment relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The role assignment identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The role assignment resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident responder resource type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -5770,101 +10069,66 @@ "html": "" } }, - "CreateIncidentIntegration": { + "CreateIncidentResponder": { "responses": { "201": { "json": { "data": { "attributes": { - "created": "2019-09-19T10:00:00.000Z", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "team_id": "T01234567" - } - ] - }, - "modified": "2019-09-19T10:00:00.000Z", - "status": "integer" + "created": "2024-01-01T00:00:00.000Z", + "external_id": null, + "external_source": null, + "is_billable": true, + "last_active": "2024-01-01T00:00:00.000Z", + "meta": {}, + "modified": "2024-01-01T00:00:00.000Z" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { - "created_by_user": { + "created_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, - "last_modified_by_user": { + "last_modified_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } + }, + "role_assignments": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_role_assignments" + } + ] + }, + "user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } } }, - "type": "incident_integrations" + "type": "incident_responders" }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident responder data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident responder in a response.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the responder was created.

\n
\n \n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

The external ID of the responder.

\n
\n \n
\n
\n
\n
\n
\n

external_source

\n
\n

string

\n

The external source of the responder.

\n
\n \n
\n
\n
\n
\n
\n

is_billable [required]

\n
\n

boolean

\n

Whether this responder counts toward billing.

\n
\n \n
\n
\n
\n
\n
\n

last_active

\n
\n

date-time

\n

Timestamp when the responder was last active.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional metadata for the responder.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the responder was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The responder identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident responder.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

role_assignments

\n
\n

object

\n

Relationship to role assignments for a responder.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of role assignment relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The role assignment identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The role assignment resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident responder resource type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -5910,45 +10174,34 @@ "request": { "json_curl": { "data": { - "attributes": { - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" - } - ] + "relationships": { + "user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } } }, - "type": "incident_integrations" + "type": "incident_responders" } }, "json": { "data": { - "attributes": { - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "team_id": "T01234567" - } - ] - }, - "status": "integer" + "relationships": { + "user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } + } }, - "type": "incident_integrations" + "type": "incident_responders" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident responder data in a create request.

\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships for creating an incident responder.

\n
\n
\n
\n
\n
\n

user [required]

\n
\n

object

\n

Relationship to a user for a responder create request.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user relationship data object for creating a responder.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The user identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The user resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident responder resource type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
" } }, - "DeleteIncidentIntegration": { + "DeleteIncidentResponder": { "responses": { "400": { "json": { @@ -5997,101 +10250,66 @@ "html": "" } }, - "GetIncidentIntegration": { + "GetIncidentResponder": { "responses": { "200": { "json": { "data": { "attributes": { - "created": "2019-09-19T10:00:00.000Z", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "team_id": "T01234567" - } - ] - }, - "modified": "2019-09-19T10:00:00.000Z", - "status": "integer" + "created": "2024-01-01T00:00:00.000Z", + "external_id": null, + "external_source": null, + "is_billable": true, + "last_active": "2024-01-01T00:00:00.000Z", + "meta": {}, + "modified": "2024-01-01T00:00:00.000Z" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { - "created_by_user": { + "created_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, - "last_modified_by_user": { + "last_modified_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } + }, + "role_assignments": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "type": "incident_role_assignments" + } + ] + }, + "user": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "users" + } } }, - "type": "incident_integrations" + "type": "incident_responders" }, "included": [ - { - "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, - "email": "string", - "handle": "string", - "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", - "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false - }, - "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" }, + "id": "string", "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident responder data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an incident responder in a response.

\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the responder was created.

\n
\n \n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

The external ID of the responder.

\n
\n \n
\n
\n
\n
\n
\n

external_source

\n
\n

string

\n

The external source of the responder.

\n
\n \n
\n
\n
\n
\n
\n

is_billable [required]

\n
\n

boolean

\n

Whether this responder counts toward billing.

\n
\n \n
\n
\n
\n
\n
\n

last_active

\n
\n

date-time

\n

Timestamp when the responder was last active.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional metadata for the responder.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the responder was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The responder identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for an incident responder.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

role_assignments

\n
\n

object

\n

Relationship to role assignments for a responder.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of role assignment relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The role assignment identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The role assignment resource type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident responder resource type. \nAllowed enum values: incident_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -6140,9 +10358,9 @@ "html": "" } }, - "UpdateIncidentIntegration": { + "CreateIncidentServiceNowRecord": { "responses": { - "200": { + "201": { "json": { "data": { "attributes": { @@ -6281,286 +10499,74 @@ "json_curl": { "data": { "attributes": { - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" - } - ] - } + "assignment_group": "IT Support", + "configuration_item_mapping": "my-service", + "instance_name": "my-instance" }, - "type": "incident_integrations" + "type": "incident_servicenow_record_prompt" } }, "json": { "data": { "attributes": { - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "integration_type": 1, - "metadata": { - "channels": [ - { - "channel_id": "C0123456789", - "channel_name": "#example-channel-name", - "redirect_url": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "team_id": "T01234567" - } - ] - }, - "status": "integer" + "assignment_group": "IT Support", + "configuration_item_mapping": "my-service", + "instance_name": "my-instance", + "record_id": "abc123def456" }, - "type": "incident_integrations" + "type": "incident_servicenow_record_prompt" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata data for a patch request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n7 indicates Microsoft Teams;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

ServiceNow record data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a ServiceNow record for an incident.

\n
\n
\n
\n
\n
\n

assignment_group [required]

\n
\n

string

\n

The ServiceNow assignment group.

\n
\n \n
\n
\n
\n
\n
\n

configuration_item_mapping [required]

\n
\n

string

\n

The ServiceNow configuration item mapping.

\n
\n \n
\n
\n
\n
\n
\n

instance_name [required]

\n
\n

string

\n

The ServiceNow instance name.

\n
\n \n
\n
\n
\n
\n
\n

record_id

\n
\n

string

\n

An existing ServiceNow record ID (Sys ID) to link instead of creating a new record.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

ServiceNow record prompt resource type. \nAllowed enum values: incident_servicenow_record_prompt

\n
\n \n
\n
\n
\n
" } }, - "ListIncidentTodos": { + "ListTimestampOverrides": { "responses": { "200": { "json": { "data": [ { "attributes": { - "assignees": [ - { - "description": "@test.user@test.com", - "example": "@test.user@test.com", - "type": "@test.user@test.com" - } - ], - "completed": "2023-03-06T22:00:00.000000+00:00", - "content": "Restore lost data.", - "created": "2019-09-19T10:00:00.000Z", - "due_date": "2023-07-10T05:00:00.000000+00:00", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "modified": "2019-09-19T10:00:00.000Z" + "created_at": "2024-01-01T00:00:00.000Z", + "deleted_at": null, + "incident_id": "00000000-0000-0000-0000-000000000000", + "modified_at": "2024-01-01T00:00:00.000Z", + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } - }, - "type": "incident_todos" - } - ], - "included": [ - { - "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, - "email": "string", - "handle": "string", - "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", - "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false - }, - "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, - "type": "users" - } - ], - "meta": { - "pagination": { - "next_offset": 1000, - "offset": 10, - "size": 1000 - } - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident todos.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" - }, - "400": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "401": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "403": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "404": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - }, - "429": { - "json": { - "errors": [ - "Bad Request" - ] - }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" - } - }, - "request": { - "json_curl": {}, - "json": {}, - "html": "" - } - }, - "CreateIncidentTodo": { - "responses": { - "201": { - "json": { - "data": { - "attributes": { - "assignees": [ - { - "description": "@test.user@test.com", - "example": "@test.user@test.com", - "type": "@test.user@test.com" - } - ], - "completed": "2023-03-06T22:00:00.000000+00:00", - "content": "Restore lost data.", - "created": "2019-09-19T10:00:00.000Z", - "due_date": "2023-07-10T05:00:00.000000+00:00", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "modified": "2019-09-19T10:00:00.000Z" - }, - "id": "00000000-0000-0000-1234-000000000000", - "relationships": { - "created_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - } - }, - "type": "incident_todos" - }, - "included": [ - { - "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, - "email": "string", - "handle": "string", - "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", - "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false - }, - "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] + "type": "users" + } }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } } }, + "type": "incidents_timestamp_overrides" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of timestamp overrides.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a timestamp override in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the override was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

Timestamp when the override was deleted.

\n
\n \n
\n
\n
\n
\n
\n

incident_id [required]

\n
\n

string

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the override was last modified.

\n
\n \n
\n
\n
\n
\n
\n

timestamp_type [required]

\n
\n

enum

\n

The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared

\n
\n \n
\n
\n
\n
\n
\n

timestamp_value [required]

\n
\n

date-time

\n

The overridden timestamp value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The timestamp override identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a timestamp override.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -6604,40 +10610,57 @@ } }, "request": { - "json_curl": { - "data": { - "attributes": { - "assignees": [ - {} - ], - "content": "Restore lost data." - }, - "type": "incident_todos" - } - }, - "json": { - "data": { - "attributes": { - "assignees": [ - { - "description": "@test.user@test.com", - "example": "@test.user@test.com", - "type": "@test.user@test.com" - } - ], - "completed": "2023-03-06T22:00:00.000000+00:00", - "content": "Restore lost data.", - "due_date": "2023-07-10T05:00:00.000000+00:00", - "incident_id": "00000000-aaaa-0000-0000-000000000000" - }, - "type": "incident_todos" - } - }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
" + "json_curl": {}, + "json": {}, + "html": "" } }, - "DeleteIncidentTodo": { + "CreateTimestampOverride": { "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created_at": "2024-01-01T00:00:00.000Z", + "deleted_at": null, + "incident_id": "00000000-0000-0000-0000-000000000000", + "modified_at": "2024-01-01T00:00:00.000Z", + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" + }, + "id": "00000000-0000-0000-0000-000000000000", + "relationships": { + "created_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + } + }, + "type": "incidents_timestamp_overrides" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Timestamp override data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a timestamp override in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the override was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

Timestamp when the override was deleted.

\n
\n \n
\n
\n
\n
\n
\n

incident_id [required]

\n
\n

string

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the override was last modified.

\n
\n \n
\n
\n
\n
\n
\n

timestamp_type [required]

\n
\n

enum

\n

The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared

\n
\n \n
\n
\n
\n
\n
\n

timestamp_value [required]

\n
\n

date-time

\n

The overridden timestamp value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The timestamp override identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a timestamp override.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + }, "400": { "json": { "errors": [ @@ -6680,32 +10703,41 @@ } }, "request": { - "json_curl": {}, - "json": {}, - "html": "" + "json_curl": { + "data": { + "attributes": { + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" + }, + "type": "incidents_timestamp_overrides" + } + }, + "json": { + "data": { + "attributes": { + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" + }, + "type": "incidents_timestamp_overrides" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Timestamp override data in a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a timestamp override.

\n
\n
\n
\n
\n
\n

timestamp_type [required]

\n
\n

enum

\n

The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared

\n
\n \n
\n
\n
\n
\n
\n

timestamp_value [required]

\n
\n

date-time

\n

The overridden timestamp value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides

\n
\n \n
\n
\n
\n
" } }, - "GetIncidentTodo": { + "DeleteTimestampOverride": { "responses": { "200": { "json": { "data": { "attributes": { - "assignees": [ - { - "description": "@test.user@test.com", - "example": "@test.user@test.com", - "type": "@test.user@test.com" - } - ], - "completed": "2023-03-06T22:00:00.000000+00:00", - "content": "Restore lost data.", - "created": "2019-09-19T10:00:00.000Z", - "due_date": "2023-07-10T05:00:00.000000+00:00", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "modified": "2019-09-19T10:00:00.000Z" + "created_at": "2024-01-01T00:00:00.000Z", + "deleted_at": null, + "incident_id": "00000000-0000-0000-0000-000000000000", + "modified_at": "2024-01-01T00:00:00.000Z", + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { @@ -6720,64 +10752,23 @@ } } }, - "type": "incident_todos" + "type": "incidents_timestamp_overrides" }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Timestamp override data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a timestamp override in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the override was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

Timestamp when the override was deleted.

\n
\n \n
\n
\n
\n
\n
\n

incident_id [required]

\n
\n

string

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the override was last modified.

\n
\n \n
\n
\n
\n
\n
\n

timestamp_type [required]

\n
\n

enum

\n

The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared

\n
\n \n
\n
\n
\n
\n
\n

timestamp_value [required]

\n
\n

date-time

\n

The overridden timestamp value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The timestamp override identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a timestamp override.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -6826,27 +10817,20 @@ "html": "" } }, - "UpdateIncidentTodo": { + "UpdateTimestampOverride": { "responses": { "200": { "json": { "data": { "attributes": { - "assignees": [ - { - "description": "@test.user@test.com", - "example": "@test.user@test.com", - "type": "@test.user@test.com" - } - ], - "completed": "2023-03-06T22:00:00.000000+00:00", - "content": "Restore lost data.", - "created": "2019-09-19T10:00:00.000Z", - "due_date": "2023-07-10T05:00:00.000000+00:00", - "incident_id": "00000000-aaaa-0000-0000-000000000000", - "modified": "2019-09-19T10:00:00.000Z" + "created_at": "2024-01-01T00:00:00.000Z", + "deleted_at": null, + "incident_id": "00000000-0000-0000-0000-000000000000", + "modified_at": "2024-01-01T00:00:00.000Z", + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" }, - "id": "00000000-0000-0000-1234-000000000000", + "id": "00000000-0000-0000-0000-000000000000", "relationships": { "created_by_user": { "data": { @@ -6861,64 +10845,23 @@ } } }, - "type": "incident_todos" + "type": "incidents_timestamp_overrides" }, "included": [ { "attributes": { - "created_at": "2019-09-19T10:00:00.000Z", - "disabled": false, "email": "string", "handle": "string", "icon": "string", - "last_login_time": "2019-09-19T10:00:00.000Z", - "mfa_enabled": false, - "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", - "service_account": false, - "status": "string", - "title": "string", - "uuid": "string", - "verified": false + "uuid": "string" }, "id": "string", - "relationships": { - "org": { - "data": { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - }, - "other_orgs": { - "data": [ - { - "id": "00000000-0000-beef-0000-000000000000", - "type": "orgs" - } - ] - }, - "other_users": { - "data": [ - { - "id": "00000000-0000-0000-2345-000000000000", - "type": "users" - } - ] - }, - "roles": { - "data": [ - { - "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "roles" - } - ] - } - }, "type": "users" } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Timestamp override data in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a timestamp override in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the override was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

Timestamp when the override was deleted.

\n
\n \n
\n
\n
\n
\n
\n

incident_id [required]

\n
\n

string

\n

The incident identifier.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the override was last modified.

\n
\n \n
\n
\n
\n
\n
\n

timestamp_type [required]

\n
\n

enum

\n

The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared

\n
\n \n
\n
\n
\n
\n
\n

timestamp_value [required]

\n
\n

date-time

\n

The overridden timestamp value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The timestamp override identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships for a timestamp override.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included related resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

UUID of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -6964,34 +10907,21 @@ "request": { "json_curl": { "data": { - "attributes": { - "assignees": [ - {} - ], - "content": "Restore lost data." - }, - "type": "incident_todos" + "id": "00000000-0000-0000-0000-000000000000", + "type": "incidents_timestamp_overrides" } }, "json": { "data": { "attributes": { - "assignees": [ - { - "description": "@test.user@test.com", - "example": "@test.user@test.com", - "type": "@test.user@test.com" - } - ], - "completed": "2023-03-06T22:00:00.000000+00:00", - "content": "Restore lost data.", - "due_date": "2023-07-10T05:00:00.000000+00:00", - "incident_id": "00000000-aaaa-0000-0000-000000000000" + "timestamp_type": "detected", + "timestamp_value": "2024-01-01T10:00:00.000Z" }, - "type": "incident_todos" + "id": "00000000-0000-0000-0000-000000000000", + "type": "incidents_timestamp_overrides" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo data for a patch request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Timestamp override data in a patch request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for patching a timestamp override. All fields are optional.

\n
\n
\n
\n
\n
\n

timestamp_type

\n
\n

enum

\n

The type of timestamp to override. \nAllowed enum values: created,detected,resolved,declared

\n
\n \n
\n
\n
\n
\n
\n

timestamp_value

\n
\n

date-time

\n

The overridden timestamp value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The timestamp override identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident timestamp override resource type. \nAllowed enum values: incidents_timestamp_overrides

\n
\n \n
\n
\n
\n
" } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 306ca0d990c..fe8ea64553d 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -675,6 +675,22 @@ components: required: true schema: type: string + IncidentGoogleChatConfigurationIDPathParameter: + description: The UUID of the Google Chat configuration. + in: path + name: id + required: true + schema: + format: uuid + type: string + IncidentGoogleMeetConfigurationIDPathParameter: + description: The UUID of the Google Meet configuration. + in: path + name: id + required: true + schema: + format: uuid + type: string IncidentIDPathParameter: description: The UUID of the incident. in: path @@ -682,6 +698,14 @@ components: required: true schema: type: string + IncidentImpactFieldIDPathParameter: + description: The UUID of the impact field. + in: path + name: field_id + required: true + schema: + format: uuid + type: string IncidentImpactIDPathParameter: description: The UUID of the incident impact. in: path @@ -774,6 +798,30 @@ components: schema: example: "created_by_user,incident_type" type: string + IncidentOrgSettingsTypeIDPathParameter: + description: The UUID of the incident type. + in: path + name: incident_type_id + required: true + schema: + format: uuid + type: string + IncidentResponderIDPathParameter: + description: The UUID of the incident responder. + in: path + name: responder_id + required: true + schema: + format: uuid + type: string + IncidentRuleIDPathParameter: + description: The UUID of the incident rule. + in: path + name: rule_id + required: true + schema: + format: uuid + type: string IncidentSearchIncludeQueryParameter: description: Specifies which types of related objects should be included in the response. in: query @@ -822,6 +870,14 @@ components: schema: example: "ExampleServiceName" type: string + IncidentTimestampOverrideIDPathParameter: + description: The UUID of the timestamp override. + in: path + name: id + required: true + schema: + format: uuid + type: string IncidentTodoIDPathParameter: description: The UUID of the incident todo. in: path @@ -851,6 +907,15 @@ components: schema: example: "00000000-0000-0000-0000-000000000000" type: string + IncidentUserDefinedRoleIDPathParameter: + description: The UUID of the incident user-defined role. + in: path + name: role_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000002" + format: uuid + type: string Include: description: Include relationship data. explode: true @@ -38824,6 +38889,71 @@ components: type: string x-mimetype: application/xml type: object + IncidentAIPostmortemDataAttributesResponse: + description: Attributes of an AI-generated incident postmortem. + properties: + action_items: + description: Action items to prevent recurrence. + example: "1. Improve failover testing. 2. Add more monitoring alerts." + type: string + customer_impact: + description: The impact of the incident on customers. + example: "5% of users experienced timeouts for 30 minutes." + type: string + executive_summary: + description: An executive summary of the incident. + example: "A database failover caused a 30-minute service outage affecting 5% of users." + type: string + key_insights: + description: Key insights from the incident. + example: "The auto-failover mechanism was slower than expected under high load." + type: string + key_timeline: + description: Key timeline events during the incident. + example: "10:00 - Alert fired. 10:05 - On-call engineer paged. 10:30 - Issue resolved." + type: string + lessons_learned: + description: Lessons learned from the incident. + example: "We need to test the failover process under realistic load conditions." + type: string + system_overview: + description: An overview of the affected systems. + example: "The primary database cluster experienced a failover event." + type: string + type: object + IncidentAIPostmortemDataResponse: + description: AI postmortem data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentAIPostmortemDataAttributesResponse" + id: + description: The incident identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentAIPostmortemResponseType" + required: + - id + - type + - attributes + type: object + IncidentAIPostmortemResponse: + description: Response with an AI-generated incident postmortem. + properties: + data: + $ref: "#/components/schemas/IncidentAIPostmortemDataResponse" + required: + - data + type: object + IncidentAIPostmortemResponseType: + description: AI postmortem response resource type. + enum: + - get_incident_ai_postmortem_response + example: get_incident_ai_postmortem_response + type: string + x-enum-varnames: + - GET_INCIDENT_AI_POSTMORTEM_RESPONSE IncidentAttachmentType: default: incident_attachments description: The incident attachment resource type. @@ -38833,6 +38963,175 @@ components: type: string x-enum-varnames: - INCIDENT_ATTACHMENTS + IncidentConfigurationDataAttributesRequest: + description: Attributes for creating an incident configuration. + properties: + execute_integrations: + description: Whether to execute integrations for this incident. + example: true + type: boolean + execute_notification_rules: + description: Whether to execute notification rules for this incident. + example: true + type: boolean + include_in_analytics: + description: Whether to include this incident in analytics. + example: true + type: boolean + include_in_search: + description: Whether to include this incident in search results. + example: true + type: boolean + type: object + IncidentConfigurationDataAttributesResponse: + description: Attributes of an incident configuration in a response. + properties: + created_at: + description: Timestamp when the configuration was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + execute_integrations: + description: Whether integrations are executed for this incident. + example: true + type: boolean + execute_notification_rules: + description: Whether notification rules are executed for this incident. + example: true + type: boolean + incident_id: + description: The incident identifier. + example: 00000000-0000-0000-0000-000000000000 + type: string + include_in_analytics: + description: Whether this incident is included in analytics. + example: true + type: boolean + include_in_search: + description: Whether this incident is included in search results. + example: true + type: boolean + modified_at: + description: Timestamp when the configuration was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + required: + - incident_id + - created_at + - modified_at + type: object + IncidentConfigurationDataRequest: + description: Incident configuration data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentConfigurationDataAttributesRequest" + type: + $ref: "#/components/schemas/IncidentConfigurationType" + required: + - type + type: object + IncidentConfigurationDataResponse: + description: Incident configuration data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentConfigurationDataAttributesResponse" + id: + description: The incident configuration identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentConfigurationRelationships" + type: + $ref: "#/components/schemas/IncidentConfigurationType" + required: + - id + - type + - attributes + type: object + IncidentConfigurationPatchDataAttributesRequest: + description: Attributes for patching an incident configuration. All fields are optional. + properties: + execute_integrations: + description: Whether to execute integrations for this incident. + example: true + type: boolean + execute_notification_rules: + description: Whether to execute notification rules for this incident. + example: true + type: boolean + include_in_analytics: + description: Whether to include this incident in analytics. + example: true + type: boolean + include_in_search: + description: Whether to include this incident in search results. + example: true + type: boolean + type: object + IncidentConfigurationPatchDataRequest: + description: Incident configuration data in a patch request. + properties: + attributes: + $ref: "#/components/schemas/IncidentConfigurationPatchDataAttributesRequest" + id: + description: The incident configuration identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentConfigurationType" + required: + - id + - type + type: object + IncidentConfigurationPatchRequest: + description: Request payload for patching an incident configuration. + properties: + data: + $ref: "#/components/schemas/IncidentConfigurationPatchDataRequest" + required: + - data + type: object + IncidentConfigurationRelationships: + description: Relationships for an incident configuration. + properties: + created_by_user: + $ref: "#/components/schemas/RelationshipToUser" + last_modified_by_user: + $ref: "#/components/schemas/RelationshipToUser" + type: object + IncidentConfigurationRequest: + description: Request payload for creating an incident configuration. + properties: + data: + $ref: "#/components/schemas/IncidentConfigurationDataRequest" + required: + - data + type: object + IncidentConfigurationResponse: + description: Response with an incident configuration. + properties: + data: + $ref: "#/components/schemas/IncidentConfigurationDataResponse" + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentConfigurationType: + description: Incident configuration resource type. + enum: + - incidents_configurations + example: incidents_configurations + type: string + x-enum-varnames: + - INCIDENTS_CONFIGURATIONS IncidentCreateAttributes: description: The incident's attributes for a create request. properties: @@ -38890,6 +39189,117 @@ components: - type - attributes type: object + IncidentCreateOnCallPageDataAttributesRequest: + description: Attributes for creating an on-call page from an incident. + properties: + description: + description: The description of the page. + example: A critical incident affecting production systems. + type: string + role: + $ref: "#/components/schemas/IncidentPageRoleReference" + services: + description: List of affected services. + example: + - web-store + items: + type: string + type: array + tags: + description: List of tags for the page. + example: + - env:prod + items: + type: string + type: array + target: + $ref: "#/components/schemas/IncidentPageTarget" + title: + description: The title of the page. + example: Production outage - SEV-1 + type: string + type: object + IncidentCreateOnCallPageDataRequest: + description: On-call page data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentCreateOnCallPageDataAttributesRequest" + type: + $ref: "#/components/schemas/IncidentCreatePageFromIncidentType" + required: + - type + - attributes + type: object + IncidentCreateOnCallPageRequest: + description: Request payload for creating an on-call page from an incident. + properties: + data: + $ref: "#/components/schemas/IncidentCreateOnCallPageDataRequest" + required: + - data + type: object + IncidentCreatePageFromIncidentDataAttributesRequest: + description: Attributes for creating a page from an incident. + properties: + description: + description: The description of the page. + example: A critical incident affecting production systems. + type: string + incident_public_id: + description: The public ID of the incident. + example: "12345" + type: string + role: + $ref: "#/components/schemas/IncidentPageRoleReference" + services: + description: List of affected services. + example: + - web-store + - checkout + items: + type: string + type: array + tags: + description: List of tags for the page. + example: + - env:prod + items: + type: string + type: array + target: + $ref: "#/components/schemas/IncidentPageTarget" + title: + description: The title of the page. + example: Production outage - SEV-1 + type: string + type: object + IncidentCreatePageFromIncidentDataRequest: + description: Page data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentCreatePageFromIncidentDataAttributesRequest" + type: + $ref: "#/components/schemas/IncidentCreatePageFromIncidentType" + required: + - type + - attributes + type: object + IncidentCreatePageFromIncidentRequest: + description: Request payload for creating a page from an incident. + properties: + data: + $ref: "#/components/schemas/IncidentCreatePageFromIncidentDataRequest" + required: + - data + type: object + IncidentCreatePageFromIncidentType: + description: Resource type for a page creation request. + enum: + - page + example: page + type: string + x-enum-varnames: + - PAGE IncidentCreateRelationships: description: The relationships the incident will have with other resources once created. properties: @@ -38963,6 +39373,351 @@ components: - TEXTARRAY - METRICTAG - AUTOCOMPLETE + IncidentGoogleChatConfigurationDataAttributesRequest: + description: Attributes for creating a Google Chat configuration. + properties: + domain_id: + description: The Google Chat domain ID. + example: my-domain + type: string + space_name_template: + description: The template for the Google Chat space name. + example: "{{incident.title}}" + type: string + space_target_audience_id: + description: The target audience ID for the Google Chat space. + example: "123456789" + type: string + space_time_zone: + description: The time zone for the Google Chat space. + example: America/New_York + type: string + required: + - domain_id + - space_name_template + - space_time_zone + - space_target_audience_id + type: object + IncidentGoogleChatConfigurationDataAttributesResponse: + description: Attributes of a Google Chat configuration. + properties: + created_at: + description: Timestamp when the configuration was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + domain_id: + description: The Google Chat domain ID. + example: my-domain + type: string + modified_at: + description: Timestamp when the configuration was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + space_name_template: + description: The template for the Google Chat space name. + example: "{{incident.title}}" + type: string + space_target_audience_id: + description: The target audience ID for the Google Chat space. + example: "123456789" + type: string + space_time_zone: + description: The time zone for the Google Chat space. + example: America/New_York + type: string + required: + - domain_id + - space_name_template + - space_time_zone + - space_target_audience_id + - created_at + - modified_at + type: object + IncidentGoogleChatConfigurationDataRequest: + description: Google Chat configuration data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataAttributesRequest" + relationships: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationRelationshipsRequest" + type: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationType" + required: + - type + - attributes + - relationships + type: object + IncidentGoogleChatConfigurationDataResponse: + description: Google Chat configuration data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataAttributesResponse" + id: + description: The configuration identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationRelationships" + type: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationType" + required: + - id + - type + - attributes + type: object + IncidentGoogleChatConfigurationPatchDataAttributesRequest: + description: Attributes for patching a Google Chat configuration. All fields are optional. + properties: + domain_id: + description: The Google Chat domain ID. + example: my-domain + type: string + space_name_template: + description: The template for the Google Chat space name. + example: "{{incident.title}}" + type: string + space_target_audience_id: + description: The target audience ID for the Google Chat space. + example: "123456789" + type: string + space_time_zone: + description: The time zone for the Google Chat space. + example: America/New_York + type: string + type: object + IncidentGoogleChatConfigurationPatchDataRequest: + description: Google Chat configuration data in a patch request. + properties: + attributes: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationPatchDataAttributesRequest" + id: + description: The configuration identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationType" + required: + - id + - type + type: object + IncidentGoogleChatConfigurationPatchRequest: + description: Request payload for patching a Google Chat configuration. + properties: + data: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationPatchDataRequest" + required: + - data + type: object + IncidentGoogleChatConfigurationRelationships: + description: Relationships for a Google Chat configuration. + properties: + created_by_user: + $ref: "#/components/schemas/RelationshipToUser" + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + last_modified_by_user: + $ref: "#/components/schemas/RelationshipToUser" + type: object + IncidentGoogleChatConfigurationRelationshipsRequest: + description: Relationships for a Google Chat configuration create request. + properties: + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + required: + - incident_type + type: object + IncidentGoogleChatConfigurationRequest: + description: Request payload for creating a Google Chat configuration. + properties: + data: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataRequest" + required: + - data + type: object + IncidentGoogleChatConfigurationResponse: + description: Response with a Google Chat configuration. + properties: + data: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataResponse" + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentGoogleChatConfigurationType: + description: Google Chat configuration resource type. + enum: + - google_chat_configurations + example: google_chat_configurations + type: string + x-enum-varnames: + - GOOGLE_CHAT_CONFIGURATIONS + IncidentGoogleMeetConfigurationDataAttributesRequest: + description: Attributes for creating a Google Meet configuration. + properties: + allow_manual_meeting_creation: + description: Whether to allow manual meeting creation. + example: true + type: boolean + auto_summarize: + description: Whether to auto-summarize meetings. + example: false + type: boolean + required: + - allow_manual_meeting_creation + - auto_summarize + type: object + IncidentGoogleMeetConfigurationDataAttributesResponse: + description: Attributes of a Google Meet configuration. + properties: + allow_manual_meeting_creation: + description: Whether manual meeting creation is allowed. + example: true + type: boolean + auto_summarize: + description: Whether meetings are auto-summarized. + example: false + type: boolean + created_at: + description: Timestamp when the configuration was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + modified_at: + description: Timestamp when the configuration was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + required: + - allow_manual_meeting_creation + - auto_summarize + - modified_at + type: object + IncidentGoogleMeetConfigurationDataRequest: + description: Google Meet configuration data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataAttributesRequest" + relationships: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationRelationshipsRequest" + type: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationType" + required: + - type + - attributes + - relationships + type: object + IncidentGoogleMeetConfigurationDataResponse: + description: Google Meet configuration data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataAttributesResponse" + id: + description: The configuration identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationRelationships" + type: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationType" + required: + - id + - type + - attributes + type: object + IncidentGoogleMeetConfigurationPatchDataAttributesRequest: + description: Attributes for patching a Google Meet configuration. All fields are optional. + properties: + allow_manual_meeting_creation: + description: Whether to allow manual meeting creation. + example: true + type: boolean + auto_summarize: + description: Whether to auto-summarize meetings. + example: false + type: boolean + type: object + IncidentGoogleMeetConfigurationPatchDataRequest: + description: Google Meet configuration data in a patch request. + properties: + attributes: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationPatchDataAttributesRequest" + id: + description: The configuration identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationType" + required: + - id + - type + type: object + IncidentGoogleMeetConfigurationPatchRequest: + description: Request payload for patching a Google Meet configuration. + properties: + data: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationPatchDataRequest" + required: + - data + type: object + IncidentGoogleMeetConfigurationRelationships: + description: Relationships for a Google Meet configuration. + properties: + created_by_user: + $ref: "#/components/schemas/RelationshipToUser" + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + last_modified_by_user: + $ref: "#/components/schemas/RelationshipToUser" + type: object + IncidentGoogleMeetConfigurationRelationshipsRequest: + description: Relationships for a Google Meet configuration create request. + properties: + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + required: + - incident_type + type: object + IncidentGoogleMeetConfigurationRequest: + description: Request payload for creating a Google Meet configuration. + properties: + data: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataRequest" + required: + - data + type: object + IncidentGoogleMeetConfigurationResponse: + description: Response with a Google Meet configuration. + properties: + data: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataResponse" + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentGoogleMeetConfigurationType: + description: Google Meet configuration resource type. + enum: + - google_meet_configurations + example: google_meet_configurations + type: string + x-enum-varnames: + - GOOGLE_MEET_CONFIGURATIONS IncidentHandleAttributesFields: description: Dynamic fields associated with the handle example: @@ -39240,12 +39995,205 @@ components: required: - data type: object + IncidentImpactFieldChoice: + description: A choice option for a dropdown or multiselect impact field. + properties: + description: + description: The description of the choice. + example: Affects all customers + type: string + display_name: + description: The display name of the choice. + example: Critical + type: string + value: + description: The value of the choice. + example: critical + type: string + required: + - value + - display_name + type: object + IncidentImpactFieldDataAttributesRequest: + description: Attributes for creating an impact field. + properties: + display_name: + description: The display name of the impact field. + example: Customer Impact Scope + type: string + field_choices: + description: The choices for dropdown or multiselect fields. + items: + $ref: "#/components/schemas/IncidentImpactFieldChoice" + type: array + field_type: + $ref: "#/components/schemas/IncidentImpactFieldValueType" + name: + description: The normalized name of the impact field (used as identifier). + example: customer_impact_scope + type: string + tag_key: + description: The tag key associated with the field (for metrictag type). + example: env + nullable: true + type: string + required: + - name + - display_name + - field_type + type: object + IncidentImpactFieldDataAttributesResponse: + description: Attributes of an impact field in a response. + properties: + display_name: + description: The display name of the impact field. + example: Customer Impact Scope + type: string + field_choices: + description: The choices for dropdown or multiselect fields. + items: + $ref: "#/components/schemas/IncidentImpactFieldChoice" + type: array + field_type: + $ref: "#/components/schemas/IncidentImpactFieldValueType" + name: + description: The normalized name of the impact field. + example: customer_impact_scope + type: string + tag_key: + description: The tag key associated with the field. + example: env + nullable: true + type: string + required: + - name + - display_name + - field_type + type: object + IncidentImpactFieldDataRequest: + description: Impact field data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentImpactFieldDataAttributesRequest" + relationships: + $ref: "#/components/schemas/IncidentImpactFieldRelationshipsRequest" + type: + $ref: "#/components/schemas/IncidentImpactFieldType" + required: + - type + - attributes + - relationships + type: object + IncidentImpactFieldDataResponse: + description: Impact field data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentImpactFieldDataAttributesResponse" + id: + description: The impact field identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentImpactFieldRelationships" + type: + $ref: "#/components/schemas/IncidentImpactFieldType" + required: + - id + - type + - attributes + type: object + IncidentImpactFieldRelationships: + description: Relationships for an impact field. + properties: + created_by_user: + $ref: "#/components/schemas/RelationshipToUser" + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + last_modified_by_user: + $ref: "#/components/schemas/RelationshipToUser" + type: object + IncidentImpactFieldRelationshipsRequest: + description: Relationships for an impact field create request. + properties: + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + required: + - incident_type + type: object + IncidentImpactFieldRequest: + description: Request payload for creating an impact field. + properties: + data: + $ref: "#/components/schemas/IncidentImpactFieldDataRequest" + required: + - data + type: object + IncidentImpactFieldResponse: + description: Response with a single impact field. + properties: + data: + $ref: "#/components/schemas/IncidentImpactFieldDataResponse" + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentImpactFieldType: + description: Impact field resource type. + enum: + - impact_fields + example: impact_fields + type: string + x-enum-varnames: + - IMPACT_FIELDS + IncidentImpactFieldValueType: + description: The type of an impact field. + enum: + - dropdown + - text + - textarray + - metrictag + - number + - datetime + - multiselect + example: dropdown + type: string + x-enum-varnames: + - DROPDOWN + - TEXT + - TEXTARRAY + - METRICTAG + - NUMBER + - DATETIME + - MULTISELECT IncidentImpactFieldsObject: additionalProperties: {} description: An object mapping impact field names to field values. example: {"customers_impacted": "all", "products_impacted": ["shopping", "marketing"]} nullable: true type: object + IncidentImpactFieldsResponse: + description: Response with a list of impact fields. + properties: + data: + description: List of impact fields. + items: + $ref: "#/components/schemas/IncidentImpactFieldDataResponse" + type: array + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object IncidentImpactRelatedObject: description: A reference to a resource related to an incident impact. enum: @@ -40299,6 +41247,226 @@ components: - id - type type: object + IncidentOnCallPageDataAttributesRequest: + description: Attributes for linking a page to an incident. + properties: + key: + description: The key of the on-call page. + example: PAGE-12345 + type: string + page_target: + $ref: "#/components/schemas/IncidentOnCallPageTarget" + team_id: + description: The team ID associated with the page (deprecated, use page_target instead). + example: team-abc-123 + type: string + type: object + IncidentOnCallPageDataRequest: + description: On-call page data in a link request. + properties: + attributes: + $ref: "#/components/schemas/IncidentOnCallPageDataAttributesRequest" + id: + description: The ID of the on-call page to link. + example: PAGE-12345 + type: string + type: + $ref: "#/components/schemas/IncidentOnCallPageType" + required: + - id + - type + type: object + IncidentOnCallPageLinkRequest: + description: Request payload for linking an on-call page to an incident. + properties: + data: + $ref: "#/components/schemas/IncidentOnCallPageDataRequest" + required: + - data + type: object + IncidentOnCallPageTarget: + description: The target of an on-call page. + properties: + identifier: + description: The identifier of the page target. + example: my-oncall-team + type: string + type: + description: The type of the page target. + example: team_handle + type: string + required: + - type + - identifier + type: object + IncidentOnCallPageType: + description: On-call page resource type. + enum: + - page + example: page + type: string + x-enum-varnames: + - PAGE + IncidentOrgSettingsDataAttributesResponse: + description: Attributes of an incident org settings resource in a response. + properties: + created: + description: Timestamp when the settings were created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + modified: + description: Timestamp when the settings were last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + settings: + $ref: "#/components/schemas/IncidentOrgSettingsMeta" + required: + - created + - modified + - settings + type: object + IncidentOrgSettingsDataResponse: + description: Incident org settings data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentOrgSettingsDataAttributesResponse" + id: + description: The org settings identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentOrgSettingsRelationships" + type: + $ref: "#/components/schemas/IncidentOrgSettingsType" + required: + - id + - type + - attributes + type: object + IncidentOrgSettingsListResponse: + description: Response with a list of incident org settings resources. + properties: + data: + description: List of incident org settings resources. + items: + $ref: "#/components/schemas/IncidentOrgSettingsDataResponse" + type: array + required: + - data + type: object + IncidentOrgSettingsMeta: + additionalProperties: {} + description: The settings configuration for an incident org settings resource. + example: + allow_anonymous_incident_declaration: false + allow_guest_incident_declaration: false + pagerduty_paging: true + private_incidents_by_default: false + type: object + IncidentOrgSettingsRelationships: + description: Relationships for an incident org settings resource. + properties: + incident_type: + $ref: "#/components/schemas/RelationshipToIncidentType" + type: object + IncidentOrgSettingsResponse: + description: Response with a single incident org settings resource. + properties: + data: + $ref: "#/components/schemas/IncidentOrgSettingsDataResponse" + required: + - data + type: object + IncidentOrgSettingsType: + description: Incident org settings resource type. + enum: + - incident_org_settings + example: incident_org_settings + type: string + x-enum-varnames: + - INCIDENT_ORG_SETTINGS + IncidentPageRoleReference: + description: A reference to an incident role for a page. + properties: + id: + description: The role identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentPageRoleType" + required: + - type + - id + type: object + IncidentPageRoleType: + description: The type of incident role for a page. + enum: + - incident_user_defined_roles + - incident_reserved_roles + example: incident_user_defined_roles + type: string + x-enum-varnames: + - INCIDENT_USER_DEFINED_ROLES + - INCIDENT_RESERVED_ROLES + IncidentPageTarget: + description: The target recipient for a page. + properties: + identifier: + description: The identifier of the target (handle, UUID, or user UUID). + example: my-team-handle + type: string + type: + $ref: "#/components/schemas/IncidentPageTargetType" + required: + - type + - identifier + type: object + IncidentPageTargetType: + description: The type of target for a page request. + enum: + - team_handle + - team_uuid + - user_uuid + example: team_uuid + type: string + x-enum-varnames: + - TEAM_HANDLE + - TEAM_UUID + - USER_UUID + IncidentPageUUIDDataResponse: + description: Page UUID data in a response. + properties: + id: + description: The UUID of the created page. + example: 00000000-0000-0000-0000-000000000001 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentPageUUIDType" + required: + - id + - type + type: object + IncidentPageUUIDResponse: + description: Response with a page UUID. + properties: + data: + $ref: "#/components/schemas/IncidentPageUUIDDataResponse" + required: + - data + type: object + IncidentPageUUIDType: + description: Resource type for a page UUID response. + enum: + - page_uuid + example: page_uuid + type: string + x-enum-varnames: + - PAGE_UUID IncidentPostmortemType: default: incident_postmortems description: Incident postmortem resource type. @@ -40338,6 +41506,195 @@ components: type: string x-enum-varnames: - INCIDENTS + IncidentResponderDataAttributesResponse: + description: Attributes of an incident responder in a response. + properties: + created: + description: Timestamp when the responder was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + external_id: + description: The external ID of the responder. + example: + nullable: true + type: string + external_source: + description: The external source of the responder. + example: + nullable: true + type: string + is_billable: + description: Whether this responder counts toward billing. + example: true + type: boolean + last_active: + description: Timestamp when the responder was last active. + example: "2024-01-01T00:00:00.000Z" + format: date-time + nullable: true + type: string + meta: + additionalProperties: {} + description: Additional metadata for the responder. + nullable: true + type: object + modified: + description: Timestamp when the responder was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + required: + - created + - modified + - is_billable + type: object + IncidentResponderDataRequest: + description: Incident responder data in a create request. + properties: + relationships: + $ref: "#/components/schemas/IncidentResponderRelationshipsRequest" + type: + $ref: "#/components/schemas/IncidentResponderType" + required: + - type + - relationships + type: object + IncidentResponderDataResponse: + description: Incident responder data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentResponderDataAttributesResponse" + id: + description: The responder identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentResponderRelationships" + type: + $ref: "#/components/schemas/IncidentResponderType" + required: + - id + - type + - attributes + type: object + IncidentResponderRelationships: + description: Relationships for an incident responder. + properties: + created_by: + $ref: "#/components/schemas/RelationshipToUser" + last_modified_by: + $ref: "#/components/schemas/RelationshipToUser" + role_assignments: + $ref: "#/components/schemas/IncidentResponderRoleAssignmentsRelationship" + user: + $ref: "#/components/schemas/NullableRelationshipToUser" + type: object + IncidentResponderRelationshipsRequest: + description: Relationships for creating an incident responder. + properties: + user: + $ref: "#/components/schemas/IncidentResponderUserRelationship" + required: + - user + type: object + IncidentResponderRequest: + description: Request payload for creating an incident responder. + properties: + data: + $ref: "#/components/schemas/IncidentResponderDataRequest" + required: + - data + type: object + IncidentResponderResponse: + description: Response with a single incident responder. + properties: + data: + $ref: "#/components/schemas/IncidentResponderDataResponse" + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentResponderRoleAssignmentRelationshipData: + description: A single role assignment relationship data object. + properties: + id: + description: The role assignment identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + description: The role assignment resource type. + example: incident_role_assignments + type: string + required: + - id + - type + type: object + IncidentResponderRoleAssignmentsRelationship: + description: Relationship to role assignments for a responder. + properties: + data: + description: List of role assignment relationship data. + items: + $ref: "#/components/schemas/IncidentResponderRoleAssignmentRelationshipData" + type: array + type: object + IncidentResponderType: + description: Incident responder resource type. + enum: + - incident_responders + example: incident_responders + type: string + x-enum-varnames: + - INCIDENT_RESPONDERS + IncidentResponderUserRelationship: + description: Relationship to a user for a responder create request. + properties: + data: + $ref: "#/components/schemas/IncidentResponderUserRelationshipData" + required: + - data + type: object + IncidentResponderUserRelationshipData: + description: A user relationship data object for creating a responder. + properties: + id: + description: The user identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + description: The user resource type. + example: users + type: string + required: + - id + - type + type: object + IncidentRespondersResponse: + description: Response with a list of incident responders. + properties: + data: + description: List of incident responders. + items: + $ref: "#/components/schemas/IncidentResponderDataResponse" + type: array + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object IncidentRespondersType: description: The incident responders type. enum: @@ -40573,6 +41930,332 @@ components: user_defined_fields: $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFields" type: object + IncidentRuleCondition: + description: A condition for an incident rule. + properties: + field: + description: The field to match on. + example: severity + type: string + values: + description: The values to match. + example: + - SEV-1 + - SEV-2 + items: + type: string + type: array + required: + - field + - values + type: object + IncidentRuleDataAttributesRequest: + description: Attributes for creating an incident rule. + properties: + condition: + $ref: "#/components/schemas/IncidentRuleQueryCondition" + condition_table_type: + description: "The condition table type. 1 = raw query." + example: 1 + type: integer + conditions: + description: List of field-based conditions. + items: + $ref: "#/components/schemas/IncidentRuleCondition" + type: array + enabled: + description: Whether the rule is enabled. + example: true + type: boolean + execution_type: + $ref: "#/components/schemas/IncidentRuleExecutionType" + incident_type_uuid: + description: The UUID of the incident type this rule applies to. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + nullable: true + type: string + match_any_condition: + description: Whether any condition (OR logic) should match instead of all (AND logic). + example: false + type: boolean + task_id: + $ref: "#/components/schemas/IncidentRuleTaskIDType" + task_payload: + description: The JSON-encoded payload for the task. + example: "{}" + type: string + trigger: + $ref: "#/components/schemas/IncidentRuleTriggerType" + required: + - execution_type + - condition_table_type + - condition + - task_id + - task_payload + - enabled + type: object + IncidentRuleDataAttributesResponse: + description: Attributes of an incident rule in a response. + properties: + condition: + $ref: "#/components/schemas/IncidentRuleQueryCondition" + condition_table_type: + description: The condition table type. + example: 1 + type: integer + conditions: + description: List of field-based conditions. + items: + $ref: "#/components/schemas/IncidentRuleCondition" + type: array + created: + description: Timestamp when the rule was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + created_by_uuid: + description: UUID of the user who created the rule. + example: 00000000-0000-0000-0000-000000000001 + format: uuid + type: string + deleted: + description: Timestamp when the rule was deleted. + example: + format: date-time + nullable: true + type: string + enabled: + description: Whether the rule is enabled. + example: true + type: boolean + execution_type: + description: The execution type of the rule. + example: 1 + type: integer + incident_settings_association_uuid: + description: The incident settings association UUID. + example: + format: uuid + nullable: true + type: string + match_any_condition: + description: Whether any condition should match. + example: false + type: boolean + modified: + description: Timestamp when the rule was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + modified_by_uuid: + description: UUID of the user who last modified the rule. + example: 00000000-0000-0000-0000-000000000001 + format: uuid + type: string + org_id: + description: The organization ID. + example: 123456 + format: int64 + type: integer + task_id: + description: The task ID. + example: notify-incident-handles-job + nullable: true + type: string + task_payload: + description: The JSON-encoded task payload. + example: "{}" + nullable: true + type: string + trigger: + description: The trigger event for the rule. + example: incident_created_trigger + type: string + type: object + IncidentRuleDataRequest: + description: Incident rule data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentRuleDataAttributesRequest" + type: + $ref: "#/components/schemas/IncidentRuleType" + required: + - type + - attributes + type: object + IncidentRuleDataResponse: + description: Incident rule data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentRuleDataAttributesResponse" + id: + description: The rule identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentRuleResponseType" + required: + - id + - type + - attributes + type: object + IncidentRuleExecutionType: + description: The execution type of an incident rule. + enum: + - 1 + - 2 + example: 1 + format: int64 + type: integer + x-enum-varnames: + - SINGLE_EXECUTION + - MULTI_EXECUTION + IncidentRulePatchDataAttributesRequest: + description: Attributes for patching an incident rule. All fields are optional. + properties: + condition: + $ref: "#/components/schemas/IncidentRuleQueryCondition" + conditions: + description: List of field-based conditions. + items: + $ref: "#/components/schemas/IncidentRuleCondition" + type: array + enabled: + description: Whether the rule is enabled. + example: true + type: boolean + task_payload: + description: The JSON-encoded payload for the task. + example: "{}" + type: string + trigger: + $ref: "#/components/schemas/IncidentRuleTriggerType" + type: object + IncidentRulePatchDataRequest: + description: Incident rule data in a patch request. + properties: + attributes: + $ref: "#/components/schemas/IncidentRulePatchDataAttributesRequest" + id: + description: The rule identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentRuleType" + required: + - id + - type + type: object + IncidentRulePatchRequest: + description: Request payload for patching an incident rule. + properties: + data: + $ref: "#/components/schemas/IncidentRulePatchDataRequest" + required: + - data + type: object + IncidentRuleQueryCondition: + description: A query-based condition for an incident rule. + properties: + normalized_query: + description: The normalized query string. + example: "severity:SEV-1" + nullable: true + type: string + raw_query: + description: The raw query string. + example: "severity:SEV-1" + nullable: true + type: string + type: object + IncidentRuleRequest: + description: Request payload for creating an incident rule. + properties: + data: + $ref: "#/components/schemas/IncidentRuleDataRequest" + required: + - data + type: object + IncidentRuleResponse: + description: Response with a single incident rule. + properties: + data: + $ref: "#/components/schemas/IncidentRuleDataResponse" + required: + - data + type: object + IncidentRuleResponseType: + description: Incident rule response resource type. + enum: + - incidents_rules + example: incidents_rules + type: string + x-enum-varnames: + - INCIDENTS_RULES + IncidentRuleTaskIDType: + description: The task ID for an incident rule. + enum: + - 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-job + - ms-teams-suppress-summarization-job + - google-meet-suppress-summarization-job + example: notify-incident-handles-job + type: string + x-enum-varnames: + - 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_JOB + - MS_TEAMS_SUPPRESS_SUMMARIZATION_JOB + - GOOGLE_MEET_SUPPRESS_SUMMARIZATION_JOB + IncidentRuleTriggerType: + description: The trigger event for an incident rule. + enum: + - incident_saved_trigger + - incident_created_trigger + - incident_modified_trigger + example: incident_created_trigger + type: string + x-enum-varnames: + - INCIDENT_SAVED_TRIGGER + - INCIDENT_CREATED_TRIGGER + - INCIDENT_MODIFIED_TRIGGER + IncidentRuleType: + description: Incident rule resource type. + enum: + - incident_rules + example: incident_rules + type: string + x-enum-varnames: + - INCIDENT_RULES + IncidentRulesResponse: + description: Response with a list of incident rules. + properties: + data: + description: List of incident rules. + items: + $ref: "#/components/schemas/IncidentRuleDataResponse" + type: array + required: + - data + type: object IncidentSearchResponse: description: Response with incidents and facets. properties: @@ -40829,6 +42512,57 @@ components: description: An object related to an incident service which is present in the included payload. oneOf: - $ref: "#/components/schemas/User" + IncidentServiceNowRecordDataAttributesRequest: + description: Attributes for creating a ServiceNow record for an incident. + properties: + assignment_group: + description: The ServiceNow assignment group. + example: IT Support + type: string + configuration_item_mapping: + description: The ServiceNow configuration item mapping. + example: my-service + type: string + instance_name: + description: The ServiceNow instance name. + example: my-instance + type: string + record_id: + description: An existing ServiceNow record ID (Sys ID) to link instead of creating a new record. + example: abc123def456 + type: string + required: + - instance_name + - assignment_group + - configuration_item_mapping + type: object + IncidentServiceNowRecordDataRequest: + description: ServiceNow record data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentServiceNowRecordDataAttributesRequest" + type: + $ref: "#/components/schemas/IncidentServiceNowRecordPromptType" + required: + - type + - attributes + type: object + IncidentServiceNowRecordPromptType: + description: ServiceNow record prompt resource type. + enum: + - incident_servicenow_record_prompt + example: incident_servicenow_record_prompt + type: string + x-enum-varnames: + - INCIDENT_SERVICENOW_RECORD_PROMPT + IncidentServiceNowRecordRequest: + description: Request payload for creating a ServiceNow record for an incident. + properties: + data: + $ref: "#/components/schemas/IncidentServiceNowRecordDataRequest" + required: + - data + type: object IncidentServiceRelationships: description: The incident service's relationships. properties: @@ -41008,6 +42742,191 @@ components: nullable: false type: string type: object + IncidentTimestampOverrideDataAttributesRequest: + description: Attributes for creating a timestamp override. + properties: + timestamp_type: + $ref: "#/components/schemas/IncidentTimestampType" + timestamp_value: + description: The overridden timestamp value. + example: "2024-01-01T10:00:00.000Z" + format: date-time + type: string + required: + - timestamp_type + - timestamp_value + type: object + IncidentTimestampOverrideDataAttributesResponse: + description: Attributes of a timestamp override in a response. + properties: + created_at: + description: Timestamp when the override was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + deleted_at: + description: Timestamp when the override was deleted. + example: + format: date-time + nullable: true + type: string + incident_id: + description: The incident identifier. + example: 00000000-0000-0000-0000-000000000000 + type: string + modified_at: + description: Timestamp when the override was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + timestamp_type: + $ref: "#/components/schemas/IncidentTimestampType" + timestamp_value: + description: The overridden timestamp value. + example: "2024-01-01T10:00:00.000Z" + format: date-time + type: string + required: + - incident_id + - timestamp_type + - timestamp_value + - created_at + - modified_at + type: object + IncidentTimestampOverrideDataRequest: + description: Timestamp override data in a create request. + properties: + attributes: + $ref: "#/components/schemas/IncidentTimestampOverrideDataAttributesRequest" + type: + $ref: "#/components/schemas/IncidentTimestampOverrideType" + required: + - type + - attributes + type: object + IncidentTimestampOverrideDataResponse: + description: Timestamp override data in a response. + properties: + attributes: + $ref: "#/components/schemas/IncidentTimestampOverrideDataAttributesResponse" + id: + description: The timestamp override identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentTimestampOverrideRelationships" + type: + $ref: "#/components/schemas/IncidentTimestampOverrideType" + required: + - id + - type + - attributes + type: object + IncidentTimestampOverridePatchDataAttributesRequest: + description: Attributes for patching a timestamp override. All fields are optional. + properties: + timestamp_type: + $ref: "#/components/schemas/IncidentTimestampType" + timestamp_value: + description: The overridden timestamp value. + example: "2024-01-01T10:00:00.000Z" + format: date-time + type: string + type: object + IncidentTimestampOverridePatchDataRequest: + description: Timestamp override data in a patch request. + properties: + attributes: + $ref: "#/components/schemas/IncidentTimestampOverridePatchDataAttributesRequest" + id: + description: The timestamp override identifier. + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentTimestampOverrideType" + required: + - id + - type + type: object + IncidentTimestampOverridePatchRequest: + description: Request payload for patching a timestamp override. + properties: + data: + $ref: "#/components/schemas/IncidentTimestampOverridePatchDataRequest" + required: + - data + type: object + IncidentTimestampOverrideRelationships: + description: Relationships for a timestamp override. + properties: + created_by_user: + $ref: "#/components/schemas/RelationshipToUser" + last_modified_by_user: + $ref: "#/components/schemas/RelationshipToUser" + type: object + IncidentTimestampOverrideRequest: + description: Request payload for creating a timestamp override. + properties: + data: + $ref: "#/components/schemas/IncidentTimestampOverrideDataRequest" + required: + - data + type: object + IncidentTimestampOverrideResponse: + description: Response with a single timestamp override. + properties: + data: + $ref: "#/components/schemas/IncidentTimestampOverrideDataResponse" + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentTimestampOverrideType: + description: Incident timestamp override resource type. + enum: + - incidents_timestamp_overrides + example: incidents_timestamp_overrides + type: string + x-enum-varnames: + - INCIDENTS_TIMESTAMP_OVERRIDES + IncidentTimestampOverridesResponse: + description: Response with a list of timestamp overrides. + properties: + data: + description: List of timestamp overrides. + items: + $ref: "#/components/schemas/IncidentTimestampOverrideDataResponse" + type: array + included: + description: Included related resources. + items: + $ref: "#/components/schemas/IncidentUserData" + readOnly: true + type: array + required: + - data + type: object + IncidentTimestampType: + description: The type of timestamp to override. + enum: + - created + - detected + - resolved + - declared + example: detected + type: string + x-enum-varnames: + - CREATED + - DETECTED + - RESOLVED + - DECLARED IncidentTodoAnonymousAssignee: description: Anonymous assignee entity. properties: @@ -41956,6 +43875,229 @@ components: - display_name - value type: object + IncidentUserDefinedRoleDataAttributesRequest: + description: Attributes for creating an incident user-defined role. + properties: + description: + description: A description of the user-defined role. + example: "The technical lead for the incident." + nullable: true + type: string + name: + description: The name of the user-defined role. + example: "Tech Lead" + type: string + policy: + $ref: "#/components/schemas/IncidentUserDefinedRolePolicy" + required: + - name + - policy + type: object + IncidentUserDefinedRoleDataAttributesResponse: + description: Attributes of an incident user-defined role. + properties: + created: + description: Timestamp when the role was created. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + description: + description: A description of the user-defined role. + example: "The technical lead for the incident." + nullable: true + type: string + modified: + description: Timestamp when the role was last modified. + example: "2024-01-01T00:00:00.000Z" + format: date-time + type: string + name: + description: The name of the user-defined role. + example: "Tech Lead" + type: string + policy: + $ref: "#/components/schemas/IncidentUserDefinedRolePolicy" + required: + - name + - policy + - created + - modified + type: object + IncidentUserDefinedRoleDataRequest: + description: Data for creating an incident user-defined role. + properties: + attributes: + $ref: "#/components/schemas/IncidentUserDefinedRoleDataAttributesRequest" + relationships: + $ref: "#/components/schemas/IncidentUserDefinedRoleRelationshipsRequest" + type: + $ref: "#/components/schemas/IncidentUserDefinedRoleType" + required: + - type + - attributes + - relationships + type: object + IncidentUserDefinedRoleDataResponse: + description: Data for an incident user-defined role response. + properties: + attributes: + $ref: "#/components/schemas/IncidentUserDefinedRoleDataAttributesResponse" + id: + description: The ID of the user-defined role. + example: "00000000-0000-0000-0000-000000000002" + format: uuid + type: string + relationships: + $ref: "#/components/schemas/IncidentUserDefinedRoleRelationshipsResponse" + type: + $ref: "#/components/schemas/IncidentUserDefinedRoleType" + required: + - id + - type + - attributes + type: object + IncidentUserDefinedRoleIncidentTypeRelationship: + description: Relationship to an incident type for a user-defined role. + properties: + data: + $ref: "#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationshipData" + required: + - data + type: object + IncidentUserDefinedRoleIncidentTypeRelationshipData: + description: Data for the incident type relationship of a user-defined role. + properties: + id: + description: The ID of the incident type. + example: "00000000-0000-0000-0000-000000000001" + format: uuid + type: string + type: + description: The type of the resource. + example: "incident_types" + type: string + required: + - id + - type + type: object + IncidentUserDefinedRoleIncludedItem: + description: A single included resource in a user-defined role response. + oneOf: + - $ref: "#/components/schemas/IncidentUserData" + - $ref: "#/components/schemas/IncidentTypeObject" + IncidentUserDefinedRoleIncludedResponse: + description: Included resources for an incident user-defined role response. + items: + $ref: "#/components/schemas/IncidentUserDefinedRoleIncludedItem" + type: array + IncidentUserDefinedRolePatchDataAttributesRequest: + description: Attributes for updating an incident user-defined role. + properties: + description: + description: A description of the user-defined role. + example: "The technical lead for the incident." + nullable: true + type: string + name: + description: The name of the user-defined role. + example: "Tech Lead" + type: string + policy: + $ref: "#/components/schemas/IncidentUserDefinedRolePolicy" + type: object + IncidentUserDefinedRolePatchDataRequest: + description: Data for updating an incident user-defined role. + properties: + attributes: + $ref: "#/components/schemas/IncidentUserDefinedRolePatchDataAttributesRequest" + id: + description: The ID of the user-defined role to update. + example: "00000000-0000-0000-0000-000000000002" + format: uuid + type: string + type: + $ref: "#/components/schemas/IncidentUserDefinedRoleType" + required: + - id + - type + type: object + IncidentUserDefinedRolePatchRequest: + description: Request for updating an incident user-defined role. + properties: + data: + $ref: "#/components/schemas/IncidentUserDefinedRolePatchDataRequest" + required: + - data + type: object + IncidentUserDefinedRolePolicy: + description: Policy configuration for a user-defined role. + properties: + is_single: + description: Whether this role can only be assigned to one responder at a time. + example: true + type: boolean + required: + - is_single + type: object + IncidentUserDefinedRoleRelationshipsRequest: + description: Relationships for creating a user-defined role. + properties: + incident_type: + $ref: "#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationship" + required: + - incident_type + type: object + IncidentUserDefinedRoleRelationshipsResponse: + description: Relationships of a user-defined role response. + properties: + created_by_user: + $ref: "#/components/schemas/RelationshipToUser" + incident_type: + $ref: "#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationship" + last_modified_by_user: + $ref: "#/components/schemas/RelationshipToUser" + type: object + IncidentUserDefinedRoleRequest: + description: Request for creating an incident user-defined role. + properties: + data: + $ref: "#/components/schemas/IncidentUserDefinedRoleDataRequest" + required: + - data + type: object + IncidentUserDefinedRoleResponse: + description: Response with a single incident user-defined role. + properties: + data: + $ref: "#/components/schemas/IncidentUserDefinedRoleDataResponse" + included: + $ref: "#/components/schemas/IncidentUserDefinedRoleIncludedResponse" + required: + - data + type: object + IncidentUserDefinedRoleType: + description: Incident user-defined role resource type. + enum: + - incident_user_defined_roles + example: incident_user_defined_roles + type: string + x-enum-varnames: + - INCIDENT_USER_DEFINED_ROLES + IncidentUserDefinedRolesDataResponse: + description: List of incident user-defined role data objects. + items: + $ref: "#/components/schemas/IncidentUserDefinedRoleDataResponse" + type: array + IncidentUserDefinedRolesResponse: + description: Response with a list of incident user-defined roles. + properties: + data: + $ref: "#/components/schemas/IncidentUserDefinedRolesDataResponse" + included: + $ref: "#/components/schemas/IncidentUserDefinedRoleIncludedResponse" + required: + - data + type: object IncidentsResponse: description: Response with a list of incidents. properties: @@ -121707,66 +123849,10 @@ paths: x-unstable: |- **Note**: This endpoint is in public beta and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/incidents/config/notification-rules: - get: - description: Lists all notification rules for the organization. Optionally filter by incident type. - operationId: ListIncidentNotificationRules - parameters: - - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" - responses: - "200": - content: - application/json: - examples: - default: - value: - data: - - attributes: - conditions: - - field: severity - values: - - SEV-1 - - SEV-2 - created: "2024-01-01T00:00:00+00:00" - enabled: true - handles: - - "@team-email@example.com" - modified: "2024-01-01T00:00:00+00:00" - trigger: incident_created_trigger - visibility: organization - id: 00000000-0000-0000-0000-000000000001 - type: incident_notification_rules - schema: - $ref: "#/components/schemas/IncidentNotificationRuleArray" - description: OK - "400": - $ref: "#/components/responses/BadRequestResponse" - "401": - $ref: "#/components/responses/UnauthorizedResponse" - "403": - $ref: "#/components/responses/ForbiddenResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" - "429": - $ref: "#/components/responses/TooManyRequestsResponse" - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] - summary: List incident notification rules - tags: - - Incidents - x-menu-order: 29 - x-permission: - operator: AND - permissions: - - incident_notification_settings_read - x-unstable: |- - **Note**: This endpoint is in Preview. - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/google-chat-configurations: post: - description: Creates a new notification rule. - operationId: CreateIncidentNotificationRule + description: Create a Google Chat configuration for incidents. + operationId: CreateIncidentGoogleChatConfiguration requestBody: content: application/json: @@ -121775,32 +123861,19 @@ paths: value: data: attributes: - conditions: - - field: severity - values: - - SEV-1 - - SEV-2 - enabled: true - handles: - - "@team-email@company.com" - - "@slack-channel" - renotify_on: - - status - - severity - trigger: incident_created_trigger - visibility: organization + domain_id: my-domain + space_name_template: "{{incident.title}}" + space_target_audience_id: "123456789" + space_time_zone: America/New_York relationships: incident_type: data: id: 00000000-0000-0000-0000-000000000000 type: incident_types - notification_template: - data: - id: 00000000-0000-0000-0000-000000000001 - type: notification_templates - type: incident_notification_rules + type: google_chat_configurations schema: - $ref: "#/components/schemas/CreateIncidentNotificationRuleRequest" + $ref: "#/components/schemas/IncidentGoogleChatConfigurationRequest" + description: Google Chat configuration payload. required: true responses: "201": @@ -121811,22 +123884,16 @@ paths: value: data: attributes: - conditions: - - field: severity - values: - - SEV-1 - - SEV-2 - created: "2024-01-01T00:00:00+00:00" - enabled: true - handles: - - "@team-email@example.com" - modified: "2024-01-01T00:00:00+00:00" - trigger: incident_created_trigger - visibility: organization + created_at: "2024-01-01T00:00:00.000Z" + domain_id: my-domain + modified_at: "2024-01-01T00:00:00.000Z" + space_name_template: "{{incident.title}}" + space_target_audience_id: "123456789" + space_time_zone: America/New_York id: 00000000-0000-0000-0000-000000000001 - type: incident_notification_rules + type: google_chat_configurations schema: - $ref: "#/components/schemas/IncidentNotificationRule" + $ref: "#/components/schemas/IncidentGoogleChatConfigurationResponse" description: Created "400": $ref: "#/components/responses/BadRequestResponse" @@ -121834,37 +123901,66 @@ paths: $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_notification_settings_write - summary: Create an incident notification rule + - incident_settings_write + summary: Create an incident Google Chat configuration tags: - Incidents x-codegen-request-body-name: body - x-menu-order: 30 + x-menu-order: 62 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_write + - incident_settings_write x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/incidents/config/notification-rules/{id}: - delete: - description: Deletes a notification rule by its ID. - operationId: DeleteIncidentNotificationRule + /api/v2/incidents/config/google-chat-configurations/{id}: + patch: + description: Update a Google Chat configuration for incidents. + operationId: UpdateIncidentGoogleChatConfiguration parameters: - - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" - - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + - $ref: "#/components/parameters/IncidentGoogleChatConfigurationIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + domain_id: updated-domain + id: 00000000-0000-0000-0000-000000000001 + type: google_chat_configurations + schema: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationPatchRequest" + description: Google Chat configuration patch payload. + required: true responses: - "204": - description: No Content + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000Z" + domain_id: updated-domain + modified_at: "2024-01-02T00:00:00.000Z" + space_name_template: "{{incident.title}}" + space_target_audience_id: "123456789" + space_time_zone: America/New_York + id: 00000000-0000-0000-0000-000000000001 + type: google_chat_configurations + schema: + $ref: "#/components/schemas/IncidentGoogleChatConfigurationResponse" + description: OK "400": $ref: "#/components/responses/BadRequestResponse" "401": @@ -121879,26 +123975,45 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_notification_settings_write - summary: Delete an incident notification rule + - incident_settings_write + summary: Update an incident Google Chat configuration tags: - Incidents - x-menu-order: 33 + x-codegen-request-body-name: body + x-menu-order: 63 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_write + - incident_settings_write x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - get: - description: Retrieves a specific notification rule by its ID. - operationId: GetIncidentNotificationRule - parameters: - - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" - - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + /api/v2/incidents/config/google-meet-configurations: + post: + description: Create a Google Meet configuration for incidents. + operationId: CreateIncidentGoogleMeetConfiguration + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + allow_manual_meeting_creation: true + auto_summarize: false + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + type: google_meet_configurations + schema: + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationRequest" + description: Google Meet configuration payload. + required: true responses: - "200": + "201": content: application/json: examples: @@ -121906,55 +124021,46 @@ paths: value: data: attributes: - conditions: - - field: severity - values: - - SEV-1 - - SEV-2 - created: "2024-01-01T00:00:00+00:00" - enabled: true - handles: - - "@team-email@example.com" - modified: "2024-01-01T00:00:00+00:00" - trigger: incident_created_trigger - visibility: organization + allow_manual_meeting_creation: true + auto_summarize: false + created_at: "2024-01-01T00:00:00.000Z" + modified_at: "2024-01-01T00:00:00.000Z" id: 00000000-0000-0000-0000-000000000001 - type: incident_notification_rules + type: google_meet_configurations schema: - $ref: "#/components/schemas/IncidentNotificationRule" - description: OK + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationResponse" + description: Created "400": $ref: "#/components/responses/BadRequestResponse" "401": $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_notification_settings_read - summary: Get an incident notification rule + - incident_settings_write + summary: Create an incident Google Meet configuration tags: - Incidents - x-menu-order: 31 + x-codegen-request-body-name: body + x-menu-order: 64 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_read + - incident_settings_write x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - put: - description: Updates an existing notification rule with a complete replacement. - operationId: UpdateIncidentNotificationRule + /api/v2/incidents/config/google-meet-configurations/{id}: + patch: + description: Update a Google Meet configuration for incidents. + operationId: UpdateIncidentGoogleMeetConfiguration parameters: - - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" - - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + - $ref: "#/components/parameters/IncidentGoogleMeetConfigurationIDPathParameter" requestBody: content: application/json: @@ -121963,33 +124069,12 @@ paths: value: data: attributes: - conditions: - - field: severity - values: - - SEV-1 - - SEV-2 - enabled: true - handles: - - "@team-email@company.com" - - "@slack-channel" - renotify_on: - - status - - severity - trigger: incident_created_trigger - visibility: organization + auto_summarize: true id: 00000000-0000-0000-0000-000000000001 - relationships: - incident_type: - data: - id: 00000000-0000-0000-0000-000000000000 - type: incident_types - notification_template: - data: - id: 00000000-0000-0000-0000-000000000001 - type: notification_templates - type: incident_notification_rules + type: google_meet_configurations schema: - $ref: "#/components/schemas/PutIncidentNotificationRuleRequest" + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationPatchRequest" + description: Google Meet configuration patch payload. required: true responses: "200": @@ -122000,22 +124085,14 @@ paths: value: data: attributes: - conditions: - - field: severity - values: - - SEV-1 - - SEV-2 - created: "2024-01-01T00:00:00+00:00" - enabled: true - handles: - - "@team-email@example.com" - modified: "2024-01-01T00:00:00+00:00" - trigger: incident_created_trigger - visibility: organization + allow_manual_meeting_creation: true + auto_summarize: true + created_at: "2024-01-01T00:00:00.000Z" + modified_at: "2024-01-02T00:00:00.000Z" id: 00000000-0000-0000-0000-000000000001 - type: incident_notification_rules + type: google_meet_configurations schema: - $ref: "#/components/schemas/IncidentNotificationRule" + $ref: "#/components/schemas/IncidentGoogleMeetConfigurationResponse" description: OK "400": $ref: "#/components/responses/BadRequestResponse" @@ -122031,26 +124108,23 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_notification_settings_write - summary: Update an incident notification rule + - incident_settings_write + summary: Update an incident Google Meet configuration tags: - Incidents x-codegen-request-body-name: body - x-menu-order: 32 + x-menu-order: 65 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_write + - incident_settings_write x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/incidents/config/notification-templates: + /api/v2/incidents/config/impact-fields: get: - description: Lists all notification templates. Optionally filter by incident type. - operationId: ListIncidentNotificationTemplates - parameters: - - $ref: "#/components/parameters/IncidentNotificationTemplateIncidentTypeFilterQueryParameter" - - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" + description: List all impact fields for incidents. + operationId: ListIncidentImpactFields responses: "200": content: @@ -122058,18 +124132,9 @@ paths: examples: default: value: - data: - - attributes: - category: alert - content: "An incident has been declared.\n\nTitle: {{incident.title}}" - created: "2024-01-01T00:00:00+00:00" - modified: "2024-01-01T00:00:00+00:00" - name: Incident Alert Template - subject: "{{incident.severity}} Incident: {{incident.title}}" - id: 00000000-0000-0000-0000-000000000001 - type: notification_templates + data: [] schema: - $ref: "#/components/schemas/IncidentNotificationTemplateArray" + $ref: "#/components/schemas/IncidentImpactFieldsResponse" description: OK "400": $ref: "#/components/responses/BadRequestResponse" @@ -122077,28 +124142,27 @@ paths: $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] - summary: List incident notification templates + - AuthZ: + - incident_settings_read + summary: List incident impact fields tags: - Incidents - x-menu-order: 24 + x-menu-order: 72 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_read + - incident_settings_read x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Creates a new notification template. - operationId: CreateIncidentNotificationTemplate + description: Create an impact field for incidents. + operationId: CreateIncidentImpactField requestBody: content: application/json: @@ -122107,18 +124171,25 @@ paths: value: data: attributes: - category: alert - content: "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates." - name: Incident Alert Template - subject: "{{incident.severity}} Incident: {{incident.title}}" + display_name: Customer Impact Scope + field_choices: + - description: Affects all customers + display_name: All Customers + value: all_customers + - description: Affects some customers + display_name: Some Customers + value: some_customers + field_type: dropdown + name: customer_impact_scope relationships: incident_type: data: id: 00000000-0000-0000-0000-000000000000 type: incident_types - type: notification_templates + type: impact_fields schema: - $ref: "#/components/schemas/CreateIncidentNotificationTemplateRequest" + $ref: "#/components/schemas/IncidentImpactFieldRequest" + description: Impact field payload. required: true responses: "201": @@ -122129,16 +124200,17 @@ paths: value: data: attributes: - category: alert - content: "An incident has been declared.\n\nTitle: {{incident.title}}" - created: "2024-01-01T00:00:00+00:00" - modified: "2024-01-01T00:00:00+00:00" - name: Incident Alert Template - subject: "{{incident.severity}} Incident: {{incident.title}}" + display_name: Customer Impact Scope + field_choices: + - description: Affects all customers + display_name: All Customers + value: all_customers + field_type: dropdown + name: customer_impact_scope id: 00000000-0000-0000-0000-000000000001 - type: notification_templates + type: impact_fields schema: - $ref: "#/components/schemas/IncidentNotificationTemplate" + $ref: "#/components/schemas/IncidentImpactFieldResponse" description: Created "400": $ref: "#/components/responses/BadRequestResponse" @@ -122146,34 +124218,31 @@ paths: $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" - "404": - $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_notification_settings_write - summary: Create incident notification template + - incident_settings_write + summary: Create an incident impact field tags: - Incidents x-codegen-request-body-name: body - x-menu-order: 25 + x-menu-order: 71 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_write + - incident_settings_write x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/incidents/config/notification-templates/{id}: + /api/v2/incidents/config/impact-fields/{field_id}: delete: - description: Deletes a notification template by its ID. - operationId: DeleteIncidentNotificationTemplate + description: Delete an impact field for incidents. + operationId: DeleteIncidentImpactField parameters: - - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" - - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" + - $ref: "#/components/parameters/IncidentImpactFieldIDPathParameter" responses: "204": description: No Content @@ -122191,24 +124260,44 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_notification_settings_write - summary: Delete a notification template + - incident_settings_write + summary: Delete an incident impact field tags: - Incidents - x-menu-order: 28 + x-menu-order: 74 x-permission: - operator: AND + operator: OR permissions: - - incident_notification_settings_write + - incident_settings_write x-unstable: |- - **Note**: This endpoint is in Preview. + **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - get: - description: Retrieves a specific notification template by its ID. - operationId: GetIncidentNotificationTemplate + put: + description: Update an impact field for incidents. + operationId: UpdateIncidentImpactField parameters: - - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" - - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" + - $ref: "#/components/parameters/IncidentImpactFieldIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + display_name: Customer Impact Scope Updated + field_type: dropdown + name: customer_impact_scope + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + type: impact_fields + schema: + $ref: "#/components/schemas/IncidentImpactFieldRequest" + description: Impact field update payload. + required: true responses: "200": content: @@ -122218,16 +124307,13 @@ paths: value: data: attributes: - category: alert - content: "An incident has been declared.\n\nTitle: {{incident.title}}" - created: "2024-01-01T00:00:00+00:00" - modified: "2024-01-01T00:00:00+00:00" - name: Incident Alert Template - subject: "{{incident.severity}} Incident: {{incident.title}}" + display_name: Customer Impact Scope Updated + field_type: dropdown + name: customer_impact_scope id: 00000000-0000-0000-0000-000000000001 - type: notification_templates + type: impact_fields schema: - $ref: "#/components/schemas/IncidentNotificationTemplate" + $ref: "#/components/schemas/IncidentImpactFieldResponse" description: OK "400": $ref: "#/components/responses/BadRequestResponse" @@ -122243,9 +124329,558 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_read - - incident_write - summary: Get incident notification template + - incident_settings_write + summary: Update an incident impact field + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 73 + x-permission: + operator: OR + permissions: + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/notification-rules: + get: + description: Lists all notification rules for the organization. Optionally filter by incident type. + operationId: ListIncidentNotificationRules + parameters: + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules + schema: + $ref: "#/components/schemas/IncidentNotificationRuleArray" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: List incident notification rules + tags: + - Incidents + x-menu-order: 29 + x-permission: + operator: AND + permissions: + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Creates a new notification rule. + operationId: CreateIncidentNotificationRule + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + enabled: true + handles: + - "@team-email@company.com" + - "@slack-channel" + renotify_on: + - status + - severity + trigger: incident_created_trigger + visibility: organization + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + notification_template: + data: + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + type: incident_notification_rules + schema: + $ref: "#/components/schemas/CreateIncidentNotificationRuleRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules + schema: + $ref: "#/components/schemas/IncidentNotificationRule" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write + summary: Create an incident notification rule + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 30 + x-permission: + operator: AND + permissions: + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/notification-rules/{id}: + delete: + description: Deletes a notification rule by its ID. + operationId: DeleteIncidentNotificationRule + parameters: + - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + responses: + "204": + description: No Content + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write + summary: Delete an incident notification rule + tags: + - Incidents + x-menu-order: 33 + x-permission: + operator: AND + permissions: + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Retrieves a specific notification rule by its ID. + operationId: GetIncidentNotificationRule + parameters: + - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules + schema: + $ref: "#/components/schemas/IncidentNotificationRule" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_read + summary: Get an incident notification rule + tags: + - Incidents + x-menu-order: 31 + x-permission: + operator: AND + permissions: + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: Updates an existing notification rule with a complete replacement. + operationId: UpdateIncidentNotificationRule + parameters: + - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + enabled: true + handles: + - "@team-email@company.com" + - "@slack-channel" + renotify_on: + - status + - severity + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + notification_template: + data: + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + type: incident_notification_rules + schema: + $ref: "#/components/schemas/PutIncidentNotificationRuleRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules + schema: + $ref: "#/components/schemas/IncidentNotificationRule" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write + summary: Update an incident notification rule + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 32 + x-permission: + operator: AND + permissions: + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/notification-templates: + get: + description: Lists all notification templates. Optionally filter by incident type. + operationId: ListIncidentNotificationTemplates + parameters: + - $ref: "#/components/parameters/IncidentNotificationTemplateIncidentTypeFilterQueryParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + schema: + $ref: "#/components/schemas/IncidentNotificationTemplateArray" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: List incident notification templates + tags: + - Incidents + x-menu-order: 24 + x-permission: + operator: AND + permissions: + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Creates a new notification template. + operationId: CreateIncidentNotificationTemplate + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates." + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + type: notification_templates + schema: + $ref: "#/components/schemas/CreateIncidentNotificationTemplateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + schema: + $ref: "#/components/schemas/IncidentNotificationTemplate" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write + summary: Create incident notification template + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 25 + x-permission: + operator: AND + permissions: + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/notification-templates/{id}: + delete: + description: Deletes a notification template by its ID. + operationId: DeleteIncidentNotificationTemplate + parameters: + - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" + responses: + "204": + description: No Content + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write + summary: Delete a notification template + tags: + - Incidents + x-menu-order: 28 + x-permission: + operator: AND + permissions: + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Retrieves a specific notification template by its ID. + operationId: GetIncidentNotificationTemplate + parameters: + - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + schema: + $ref: "#/components/schemas/IncidentNotificationTemplate" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + - incident_write + summary: Get incident notification template tags: - Incidents x-menu-order: 26 @@ -122434,37 +125069,315 @@ paths: "204": description: No Content "400": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Bad Request + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Delete postmortem template + tags: + - Incidents + x-menu-order: 48 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Retrieve details of a specific postmortem template. + operationId: GetIncidentPostmortemTemplate + parameters: + - description: The ID of the postmortem template + in: path + name: template_id + required: true + schema: + example: "template-456" + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + modifiedAt: "2024-01-01T00:00:00+00:00" + name: Standard Postmortem Template + id: 00000000-0000-0000-0000-000000000003 + type: postmortem_template + schema: + $ref: "#/components/schemas/PostmortemTemplateResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get postmortem template + tags: + - Incidents + x-menu-order: 46 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + patch: + description: Update an existing postmortem template. + operationId: UpdateIncidentPostmortemTemplate + parameters: + - description: The ID of the postmortem template + in: path + name: template_id + required: true + schema: + example: "template-456" + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + name: Standard Postmortem Template + type: postmortem_template + schema: + $ref: "#/components/schemas/PostmortemTemplateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + modifiedAt: "2024-01-01T00:00:00+00:00" + name: Standard Postmortem Template + id: 00000000-0000-0000-0000-000000000004 + type: postmortem_template + schema: + $ref: "#/components/schemas/PostmortemTemplateResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Update postmortem template + tags: + - Incidents + x-menu-order: 47 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/rules: + get: + description: List all incident rules. + operationId: ListIncidentRules + parameters: + - description: Filter rules by task ID. + in: query + name: "filter[task_id]" + required: false + schema: + example: notify-incident-handles-job + type: string + - description: Filter rules by trigger. + in: query + name: "filter[trigger]" + required: false + schema: + example: incident_created_trigger + type: string + - description: Filter rules by incident type UUID. + in: query + name: incidentTypeUUID + required: false + schema: + example: 00000000-0000-0000-0000-000000000000 + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: [] + schema: + $ref: "#/components/schemas/IncidentRulesResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_read + summary: List incident rules + tags: + - Incidents + x-menu-order: 66 + x-permission: + operator: OR + permissions: + - incident_settings_read + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create an incident rule. + operationId: CreateIncidentRule + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + condition: + raw_query: "severity:SEV-1" + condition_table_type: 1 + enabled: true + execution_type: 1 + task_id: notify-incident-handles-job + task_payload: "{}" + trigger: incident_created_trigger + type: incident_rules + schema: + $ref: "#/components/schemas/IncidentRuleRequest" + description: Incident rule payload. + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + condition: + raw_query: "severity:SEV-1" + condition_table_type: 1 + created: "2024-01-01T00:00:00.000Z" + enabled: true + execution_type: 1 + modified: "2024-01-01T00:00:00.000Z" + task_id: notify-incident-handles-job + task_payload: "{}" + trigger: incident_created_trigger + id: 00000000-0000-0000-0000-000000000001 + type: incidents_rules + schema: + $ref: "#/components/schemas/IncidentRuleResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Create an incident rule + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 67 + x-permission: + operator: OR + permissions: + - incident_settings_write + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/rules/{rule_id}: + delete: + description: Delete an incident rule. + operationId: DeleteIncidentRule + parameters: + - $ref: "#/components/parameters/IncidentRuleIDPathParameter" + responses: + "204": + description: No Content + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" "404": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Not Found + $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" - summary: Delete postmortem template + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Delete an incident rule tags: - Incidents - x-menu-order: 48 + x-menu-order: 70 + x-permission: + operator: OR + permissions: + - incident_settings_write + - incident_notification_settings_write x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Retrieve details of a specific postmortem template. - operationId: GetIncidentPostmortemTemplate + description: Get a single incident rule by ID. + operationId: GetIncidentRule parameters: - - description: The ID of the postmortem template - in: path - name: template_id - required: true - schema: - example: "template-456" - type: string + - $ref: "#/components/parameters/IncidentRuleIDPathParameter" responses: "200": content: @@ -122474,46 +125387,53 @@ paths: value: data: attributes: - createdAt: "2024-01-01T00:00:00+00:00" - modifiedAt: "2024-01-01T00:00:00+00:00" - name: Standard Postmortem Template - id: 00000000-0000-0000-0000-000000000003 - type: postmortem_template + condition: + raw_query: "severity:SEV-1" + condition_table_type: 1 + created: "2024-01-01T00:00:00.000Z" + enabled: true + execution_type: 1 + modified: "2024-01-01T00:00:00.000Z" + task_id: notify-incident-handles-job + task_payload: "{}" + trigger: incident_created_trigger + id: 00000000-0000-0000-0000-000000000001 + type: incidents_rules schema: - $ref: "#/components/schemas/PostmortemTemplateResponse" + $ref: "#/components/schemas/IncidentRuleResponse" description: OK "400": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Bad Request + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" "404": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Not Found + $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" - summary: Get postmortem template + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_read + summary: Get an incident rule tags: - Incidents - x-menu-order: 46 + x-menu-order: 68 + x-permission: + operator: OR + permissions: + - incident_settings_read + - incident_notification_settings_read x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Update an existing postmortem template. - operationId: UpdateIncidentPostmortemTemplate + description: Update an incident rule. + operationId: UpdateIncidentRule parameters: - - description: The ID of the postmortem template - in: path - name: template_id - required: true - schema: - example: "template-456" - type: string + - $ref: "#/components/parameters/IncidentRuleIDPathParameter" requestBody: content: application/json: @@ -122522,10 +125442,12 @@ paths: value: data: attributes: - name: Standard Postmortem Template - type: postmortem_template + enabled: false + id: 00000000-0000-0000-0000-000000000001 + type: incident_rules schema: - $ref: "#/components/schemas/PostmortemTemplateRequest" + $ref: "#/components/schemas/IncidentRulePatchRequest" + description: Incident rule patch payload. required: true responses: "200": @@ -122536,32 +125458,46 @@ paths: value: data: attributes: - createdAt: "2024-01-01T00:00:00+00:00" - modifiedAt: "2024-01-01T00:00:00+00:00" - name: Standard Postmortem Template - id: 00000000-0000-0000-0000-000000000004 - type: postmortem_template + condition: + raw_query: "severity:SEV-1" + condition_table_type: 1 + created: "2024-01-01T00:00:00.000Z" + enabled: false + execution_type: 1 + modified: "2024-01-02T00:00:00.000Z" + task_id: notify-incident-handles-job + task_payload: "{}" + trigger: incident_created_trigger + id: 00000000-0000-0000-0000-000000000001 + type: incidents_rules schema: - $ref: "#/components/schemas/PostmortemTemplateResponse" + $ref: "#/components/schemas/IncidentRuleResponse" description: OK "400": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Bad Request + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" "404": - content: - application/json: - schema: - $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Not Found + $ref: "#/components/responses/NotFoundResponse" "429": $ref: "#/components/responses/TooManyRequestsResponse" - summary: Update postmortem template + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Update an incident rule tags: - Incidents - x-menu-order: 47 + x-codegen-request-body-name: body + x-menu-order: 69 + x-permission: + operator: OR + permissions: + - incident_settings_write + - incident_notification_settings_write x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). @@ -122679,6 +125615,75 @@ paths: x-unstable: |- **Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/types/org-settings: + get: + description: List org settings for all incident types. + operationId: ListOrgSettings + parameters: + - description: Maximum number of results to return. + in: query + name: "page[size]" + required: false + schema: + example: 10 + type: integer + - description: The offset for pagination. + in: query + name: "page[offset]" + required: false + schema: + example: 0 + type: integer + - description: Whether to include deleted records. + in: query + name: include-deleted + required: false + schema: + example: false + type: boolean + - description: Comma-separated list of related resources to include in the response. + in: query + name: include + required: false + schema: + example: incident_type + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: [] + schema: + $ref: "#/components/schemas/IncidentOrgSettingsListResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: List incident type org settings + tags: + - Incidents + x-menu-order: 75 + x-permission: + operator: OR + permissions: + - incident_settings_read + - incident_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/types/{incident_type_id}: delete: description: Delete an incident type. @@ -122832,6 +125837,67 @@ paths: x-unstable: |- **Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/types/{incident_type_id}/org-settings: + get: + description: Get the org settings for a specific incident type. + operationId: GetOrgSettingsByIncidentType + parameters: + - $ref: "#/components/parameters/IncidentOrgSettingsTypeIDPathParameter" + - description: Comma-separated list of related resources to include in the response. + in: query + name: include + required: false + schema: + example: incident_type + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00.000Z" + modified: "2024-01-01T00:00:00.000Z" + settings: + allow_anonymous_incident_declaration: false + allow_guest_incident_declaration: false + pagerduty_paging: true + private_incidents_by_default: false + id: 00000000-0000-0000-0000-000000000001 + type: incident_org_settings + schema: + $ref: "#/components/schemas/IncidentOrgSettingsResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: Get org settings by incident type + tags: + - Incidents + x-menu-order: 76 + x-permission: + operator: OR + permissions: + - incident_settings_read + - incident_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/user-defined-fields: get: description: Get a list of all incident user-defined fields. @@ -123169,12 +126235,362 @@ paths: type: "users" type: "user_defined_field" schema: - $ref: "#/components/schemas/IncidentUserDefinedFieldResponse" + $ref: "#/components/schemas/IncidentUserDefinedFieldResponse" + description: OK + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: Get an incident user-defined field + tags: + - Incidents + x-menu-order: 54 + x-permission: + operator: AND + permissions: + - incident_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + patch: + description: Update an incident user-defined field. + operationId: UpdateIncidentUserDefinedField + parameters: + - $ref: "#/components/parameters/IncidentUserDefinedFieldIDPathParameter" + - description: Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type". + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + category: what_happened + collected: active + default_value: critical + display_name: Root Cause + ordinal: "1.5" + required: false + valid_values: + - description: A critical severity incident. + display_name: Critical + short_description: Critical + value: critical + id: 00000000-0000-0000-0000-000000000000 + type: user_defined_field + schema: + $ref: "#/components/schemas/IncidentUserDefinedFieldUpdateRequest" + description: Incident user-defined field update payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + attached_to: "incidents" + category: "what_happened" + collected: + created: "2026-03-18T08:39:49.913895Z" + default_value: + deleted: + display_name: "Root Cause" + metadata: + modified: "2026-03-18T08:39:49.922909Z" + name: "root_cause" + ordinal: "8" + prerequisite: + required: false + reserved: false + table_id: 0 + tag_key: + type: 3 + valid_values: + id: "13a731a3-a010-450e-b6a3-3d450a26170c" + relationships: + created_by_user: + data: + id: "8e7d4859-0916-4df8-b51c-5f5a4ea7815e" + type: "users" + incident_type: + data: + id: "95edc42f-c55d-46fa-92a1-a182646454af" + type: "incident_types" + last_modified_by_user: + data: + id: "8e7d4859-0916-4df8-b51c-5f5a4ea7815e" + type: "users" + type: "user_defined_field" + schema: + $ref: "#/components/schemas/IncidentUserDefinedFieldResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Update an incident user-defined field + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 55 + x-permission: + operator: AND + permissions: + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/user-defined-roles: + get: + description: List all user-defined roles for incidents. + operationId: ListIncidentUserDefinedRoles + parameters: + - description: Filter roles by incident type UUID. + in: query + name: filter[incident-type] + required: false + schema: + example: "00000000-0000-0000-0000-000000000001" + format: uuid + type: string + - description: Comma-separated list of related resources to include in the response. + in: query + name: include + required: false + schema: + example: "created_by_user,last_modified_by_user,incident_type" + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + created: "2024-01-01T00:00:00.000Z" + description: "The technical lead for the incident." + modified: "2024-01-01T00:00:00.000Z" + name: "Tech Lead" + policy: + is_single: true + id: "00000000-0000-0000-0000-000000000002" + type: incident_user_defined_roles + schema: + $ref: "#/components/schemas/IncidentUserDefinedRolesResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_read + summary: List incident user-defined roles + tags: + - Incidents + x-menu-order: 57 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a new user-defined role for incidents. + operationId: CreateIncidentUserDefinedRole + parameters: + - description: Comma-separated list of related resources to include in the response. + in: query + name: include + required: false + schema: + example: "created_by_user,last_modified_by_user,incident_type" + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + description: "The technical lead for the incident." + name: "Tech Lead" + policy: + is_single: true + relationships: + incident_type: + data: + id: "00000000-0000-0000-0000-000000000001" + type: incident_types + type: incident_user_defined_roles + schema: + $ref: "#/components/schemas/IncidentUserDefinedRoleRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00.000Z" + description: "The technical lead for the incident." + modified: "2024-01-01T00:00:00.000Z" + name: "Tech Lead" + policy: + is_single: true + id: "00000000-0000-0000-0000-000000000002" + type: incident_user_defined_roles + schema: + $ref: "#/components/schemas/IncidentUserDefinedRoleResponse" + description: Created + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Create an incident user-defined role + tags: + - Incidents + x-menu-order: 58 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/config/user-defined-roles/{role_id}: + delete: + description: Delete an existing user-defined role for incidents. + operationId: DeleteIncidentUserDefinedRole + parameters: + - $ref: "#/components/parameters/IncidentUserDefinedRoleIDPathParameter" + responses: + "204": + description: No Content + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Delete an incident user-defined role + tags: + - Incidents + x-menu-order: 61 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Retrieve a single user-defined role for incidents. + operationId: GetIncidentUserDefinedRole + parameters: + - $ref: "#/components/parameters/IncidentUserDefinedRoleIDPathParameter" + - description: Comma-separated list of related resources to include in the response. + in: query + name: include + required: false + schema: + example: "created_by_user,last_modified_by_user,incident_type" + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00.000Z" + description: "The technical lead for the incident." + modified: "2024-01-01T00:00:00.000Z" + name: "Tech Lead" + policy: + is_single: true + id: "00000000-0000-0000-0000-000000000002" + type: incident_user_defined_roles + schema: + $ref: "#/components/schemas/IncidentUserDefinedRoleResponse" description: OK - "401": - $ref: "#/components/responses/UnauthorizedResponse" - "403": - $ref: "#/components/responses/ForbiddenResponse" + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request "404": content: application/json: @@ -123187,27 +126603,25 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_read - summary: Get an incident user-defined field + - incident_settings_read + summary: Get an incident user-defined role tags: - Incidents - x-menu-order: 54 - x-permission: - operator: AND - permissions: - - incident_read + x-menu-order: 59 x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Update an incident user-defined field. - operationId: UpdateIncidentUserDefinedField + description: Update an existing user-defined role for incidents. + operationId: UpdateIncidentUserDefinedRole parameters: - - $ref: "#/components/parameters/IncidentUserDefinedFieldIDPathParameter" - - description: Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type". + - $ref: "#/components/parameters/IncidentUserDefinedRoleIDPathParameter" + - description: Comma-separated list of related resources to include in the response. in: query name: include + required: false schema: + example: "created_by_user,last_modified_by_user,incident_type" type: string requestBody: content: @@ -123217,22 +126631,11 @@ paths: value: data: attributes: - category: what_happened - collected: active - default_value: critical - display_name: Root Cause - ordinal: "1.5" - required: false - valid_values: - - description: A critical severity incident. - display_name: Critical - short_description: Critical - value: critical - id: 00000000-0000-0000-0000-000000000000 - type: user_defined_field + name: "Updated Tech Lead" + id: "00000000-0000-0000-0000-000000000002" + type: incident_user_defined_roles schema: - $ref: "#/components/schemas/IncidentUserDefinedFieldUpdateRequest" - description: Incident user-defined field update payload. + $ref: "#/components/schemas/IncidentUserDefinedRolePatchRequest" required: true responses: "200": @@ -123243,41 +126646,15 @@ paths: value: data: attributes: - attached_to: "incidents" - category: "what_happened" - collected: - created: "2026-03-18T08:39:49.913895Z" - default_value: - deleted: - display_name: "Root Cause" - metadata: - modified: "2026-03-18T08:39:49.922909Z" - name: "root_cause" - ordinal: "8" - prerequisite: - required: false - reserved: false - table_id: 0 - tag_key: - type: 3 - valid_values: - id: "13a731a3-a010-450e-b6a3-3d450a26170c" - relationships: - created_by_user: - data: - id: "8e7d4859-0916-4df8-b51c-5f5a4ea7815e" - type: "users" - incident_type: - data: - id: "95edc42f-c55d-46fa-92a1-a182646454af" - type: "incident_types" - last_modified_by_user: - data: - id: "8e7d4859-0916-4df8-b51c-5f5a4ea7815e" - type: "users" - type: "user_defined_field" + created: "2024-01-01T00:00:00.000Z" + modified: "2024-01-02T00:00:00.000Z" + name: "Updated Tech Lead" + policy: + is_single: true + id: "00000000-0000-0000-0000-000000000002" + type: incident_user_defined_roles schema: - $ref: "#/components/schemas/IncidentUserDefinedFieldResponse" + $ref: "#/components/schemas/IncidentUserDefinedRoleResponse" description: OK "400": content: @@ -123285,10 +126662,6 @@ paths: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - "401": - $ref: "#/components/responses/UnauthorizedResponse" - "403": - $ref: "#/components/responses/ForbiddenResponse" "404": content: application/json: @@ -123302,15 +126675,10 @@ paths: appKeyAuth: [] - AuthZ: - incident_settings_write - summary: Update an incident user-defined field + summary: Update an incident user-defined role tags: - Incidents - x-codegen-request-body-name: body - x-menu-order: 55 - x-permission: - operator: AND - permissions: - - incident_settings_write + x-menu-order: 60 x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). @@ -123653,6 +127021,58 @@ paths: x-unstable: |- **Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/ai/postmortem: + post: + description: Generate an AI postmortem for an incident. + operationId: GetIncidentAIPostmortem + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + action_items: "1. Improve failover testing." + customer_impact: "5% of users experienced timeouts for 30 minutes." + executive_summary: "A database failover caused a 30-minute service outage." + key_timeline: "10:00 - Alert fired. 10:30 - Issue resolved." + lessons_learned: "We need to test the failover process under realistic load." + system_overview: "The primary database cluster experienced a failover event." + id: 00000000-0000-0000-0000-000000000000 + type: get_incident_ai_postmortem_response + schema: + $ref: "#/components/schemas/IncidentAIPostmortemResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Get an AI-generated incident postmortem + tags: + - Incidents + x-menu-order: 91 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/attachments: get: description: List incident attachments. @@ -123953,6 +127373,214 @@ paths: x-unstable: |- **Note**: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/cases/page: + post: + description: Create a page from an incident using the Cases service. + operationId: CreatePageFromIncident + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + description: A critical incident affecting production systems. + services: + - web-store + tags: + - env:prod + target: + identifier: my-oncall-team + type: team_handle + title: Production outage - SEV-1 + type: page + schema: + $ref: "#/components/schemas/IncidentCreatePageFromIncidentRequest" + description: Page creation payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: page_uuid + schema: + $ref: "#/components/schemas/IncidentPageUUIDResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create a page from an incident + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 90 + x-permission: + operator: AND + permissions: + - oncall_page + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/configurations: + patch: + description: Update a configuration for an incident. + operationId: UpdateIncidentConfiguration + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + include_in_search: false + id: 00000000-0000-0000-0000-000000000001 + type: incidents_configurations + schema: + $ref: "#/components/schemas/IncidentConfigurationPatchRequest" + description: Incident configuration patch payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000Z" + execute_integrations: true + execute_notification_rules: true + incident_id: 00000000-0000-0000-0000-000000000000 + include_in_analytics: true + include_in_search: false + modified_at: "2024-01-02T00:00:00.000Z" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_configurations + schema: + $ref: "#/components/schemas/IncidentConfigurationResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Update an incident configuration + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 88 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a configuration for an incident. + operationId: CreateIncidentConfiguration + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + execute_integrations: true + execute_notification_rules: true + include_in_analytics: true + include_in_search: true + type: incidents_configurations + schema: + $ref: "#/components/schemas/IncidentConfigurationRequest" + description: Incident configuration payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000Z" + execute_integrations: true + execute_notification_rules: true + incident_id: 00000000-0000-0000-0000-000000000000 + include_in_analytics: true + include_in_search: true + modified_at: "2024-01-01T00:00:00.000Z" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_configurations + schema: + $ref: "#/components/schemas/IncidentConfigurationResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create an incident configuration + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 87 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/impacts: get: description: Get all impacts for an incident. @@ -123975,7 +127603,233 @@ paths: id: 00000000-0000-0000-0000-000000000001 type: incident_impacts schema: - $ref: "#/components/schemas/IncidentImpactsResponse" + $ref: "#/components/schemas/IncidentImpactsResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: List an incident's impacts + tags: + - Incidents + x-menu-order: 7 + "x-permission": + operator: OR + permissions: + - incident_read + post: + description: Create an impact for an incident. + operationId: CreateIncidentImpact + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIncludeQueryParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + description: Service was unavailable for external users + end_at: "2025-08-29T13:17:00Z" + fields: + customers_impacted: all + products_impacted: + - shopping + - marketing + start_at: "2025-08-28T13:17:00Z" + type: incident_impacts + schema: + $ref: "#/components/schemas/IncidentImpactCreateRequest" + description: Incident impact payload. + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + description: "Service was unavailable for external users" + end_at: "2024-01-01T01:00:00+00:00" + start_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000002 + type: incident_impacts + schema: + $ref: "#/components/schemas/IncidentImpactResponse" + description: CREATED + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create an incident impact + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 8 + "x-permission": + operator: OR + permissions: + - incident_write + /api/v2/incidents/{incident_id}/impacts/{impact_id}: + delete: + description: Delete an incident impact. + operationId: DeleteIncidentImpact + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIDPathParameter" + responses: + "204": + description: No Content + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Delete an incident impact + tags: + - Incidents + x-menu-order: 9 + "x-permission": + operator: OR + permissions: + - incident_write + patch: + description: Partially update an incident impact. + operationId: PatchIncidentImpact + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIncludeQueryParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + description: Patched service impact description + type: incident_impacts + schema: + $ref: "#/components/schemas/IncidentImpactCreateRequest" + description: Incident impact patch payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + description: Patched service impact description + start_at: "2025-08-28T13:17:00Z" + id: 00000000-0000-0000-0000-000000000002 + type: incident_impacts + schema: + $ref: "#/components/schemas/IncidentImpactResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Patch an incident impact + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 78 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: Update an incident impact. + operationId: UpdateIncidentImpact + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIncludeQueryParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + description: Updated service impact description + end_at: "2025-08-29T13:17:00Z" + start_at: "2025-08-28T13:17:00Z" + type: incident_impacts + schema: + $ref: "#/components/schemas/IncidentImpactCreateRequest" + description: Incident impact payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + description: Updated service impact description + end_at: "2025-08-29T13:17:00Z" + start_at: "2025-08-28T13:17:00Z" + id: 00000000-0000-0000-0000-000000000002 + type: incident_impacts + schema: + $ref: "#/components/schemas/IncidentImpactResponse" description: OK "400": $ref: "#/components/responses/BadRequestResponse" @@ -123991,21 +127845,25 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - incident_read - summary: List an incident's impacts + - incident_write + summary: Update an incident impact tags: - Incidents - x-menu-order: 7 - "x-permission": + x-codegen-request-body-name: body + x-menu-order: 77 + x-permission: operator: OR permissions: - - incident_read + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/page: post: - description: Create an impact for an incident. - operationId: CreateIncidentImpact + description: Create an on-call page directly from an incident. + operationId: CreateOnCallPageFromIncident parameters: - $ref: "#/components/parameters/IncidentIDPathParameter" - - $ref: "#/components/parameters/IncidentImpactIncludeQueryParameter" requestBody: content: application/json: @@ -124014,36 +127872,31 @@ paths: value: data: attributes: - description: Service was unavailable for external users - end_at: "2025-08-29T13:17:00Z" - fields: - customers_impacted: all - products_impacted: - - shopping - - marketing - start_at: "2025-08-28T13:17:00Z" - type: incident_impacts + description: A critical incident affecting production systems. + services: + - web-store + target: + identifier: my-oncall-team + type: team_handle + title: Production outage - SEV-1 + type: page schema: - $ref: "#/components/schemas/IncidentImpactCreateRequest" - description: Incident impact payload. + $ref: "#/components/schemas/IncidentCreateOnCallPageRequest" + description: On-call page creation payload. required: true responses: - "201": + "200": content: application/json: examples: default: value: data: - attributes: - description: "Service was unavailable for external users" - end_at: "2024-01-01T01:00:00+00:00" - start_at: "2024-01-01T00:00:00+00:00" - id: 00000000-0000-0000-0000-000000000002 - type: incident_impacts + id: 00000000-0000-0000-0000-000000000001 + type: page_uuid schema: - $ref: "#/components/schemas/IncidentImpactResponse" - description: CREATED + $ref: "#/components/schemas/IncidentPageUUIDResponse" + description: OK "400": $ref: "#/components/responses/BadRequestResponse" "401": @@ -124059,31 +127912,73 @@ paths: appKeyAuth: [] - AuthZ: - incident_write - summary: Create an incident impact + summary: Create an on-call page from an incident tags: - Incidents x-codegen-request-body-name: body - x-menu-order: 8 - "x-permission": - operator: OR + x-menu-order: 93 + x-permission: + operator: AND permissions: + - oncall_page - incident_write - /api/v2/incidents/{incident_id}/impacts/{impact_id}: - delete: - description: Delete an incident impact. - operationId: DeleteIncidentImpact + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/pages/link: + post: + description: Link an existing on-call page to an incident. + operationId: LinkPageToIncident parameters: - $ref: "#/components/parameters/IncidentIDPathParameter" - - $ref: "#/components/parameters/IncidentImpactIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + key: PAGE-12345 + page_target: + identifier: my-oncall-team + type: team_handle + id: PAGE-12345 + type: page + schema: + $ref: "#/components/schemas/IncidentOnCallPageLinkRequest" + description: On-call page link payload. + required: true responses: - "204": - description: No Content + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + integration_type: 1 + status: 1 + id: 00000000-0000-0000-0000-000000000001 + type: incident_integrations + schema: + $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" "401": $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" "404": $ref: "#/components/responses/NotFoundResponse" + "409": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Conflict - page already linked to incident "429": $ref: "#/components/responses/TooManyRequestsResponse" security: @@ -124091,14 +127986,18 @@ paths: appKeyAuth: [] - AuthZ: - incident_write - summary: Delete an incident impact + summary: Link a page to an incident tags: - Incidents - x-menu-order: 9 - "x-permission": + x-codegen-request-body-name: body + x-menu-order: 92 + x-permission: operator: OR permissions: - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/relationships/integrations: get: description: Get all integration metadata for an incident. @@ -124647,6 +128546,500 @@ paths: x-unstable: |- **Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/responders: + get: + description: List all responders for an incident. + operationId: ListIncidentResponders + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: [] + schema: + $ref: "#/components/schemas/IncidentRespondersResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: List incident responders + tags: + - Incidents + x-menu-order: 80 + x-permission: + operator: OR + permissions: + - incident_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Add a responder to an incident. + operationId: CreateIncidentResponder + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + relationships: + user: + data: + id: 00000000-0000-0000-0000-000000000001 + type: users + type: incident_responders + schema: + $ref: "#/components/schemas/IncidentResponderRequest" + description: Incident responder payload. + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00.000Z" + is_billable: true + modified: "2024-01-01T00:00:00.000Z" + id: 00000000-0000-0000-0000-000000000002 + type: incident_responders + schema: + $ref: "#/components/schemas/IncidentResponderResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create an incident responder + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 79 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/responders/{responder_id}: + delete: + description: Remove a responder from an incident. + operationId: DeleteIncidentResponder + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentResponderIDPathParameter" + responses: + "204": + description: No Content + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Delete an incident responder + tags: + - Incidents + x-menu-order: 82 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Get a single responder for an incident. + operationId: GetIncidentResponder + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentResponderIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00.000Z" + is_billable: true + modified: "2024-01-01T00:00:00.000Z" + id: 00000000-0000-0000-0000-000000000002 + type: incident_responders + schema: + $ref: "#/components/schemas/IncidentResponderResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: Get an incident responder + tags: + - Incidents + x-menu-order: 81 + x-permission: + operator: OR + permissions: + - incident_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/servicenow-records: + post: + description: Create a ServiceNow record for an incident. + operationId: CreateIncidentServiceNowRecord + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + assignment_group: IT Support + configuration_item_mapping: my-service + instance_name: my-instance + type: incident_servicenow_record_prompt + schema: + $ref: "#/components/schemas/IncidentServiceNowRecordRequest" + description: ServiceNow record payload. + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-0000-0000-0000-000000000000 + integration_type: 0 + metadata: + records: + - instance_name: my-instance + record_num: INC0001234 + redirect_url: https://my-instance.service-now.com/nav_to.do?uri=incident.do?sys_id=abc123 + status: 1 + id: 00000000-0000-0000-0000-000000000001 + type: incident_integrations + schema: + $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create an incident ServiceNow record + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 89 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/timestamp-overrides: + get: + description: List all timestamp overrides for an incident. + operationId: ListTimestampOverrides + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: [] + schema: + $ref: "#/components/schemas/IncidentTimestampOverridesResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: List incident timestamp overrides + tags: + - Incidents + x-menu-order: 83 + x-permission: + operator: OR + permissions: + - incident_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a timestamp override for an incident. + operationId: CreateTimestampOverride + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + timestamp_type: detected + timestamp_value: "2024-01-01T10:00:00.000Z" + type: incidents_timestamp_overrides + schema: + $ref: "#/components/schemas/IncidentTimestampOverrideRequest" + description: Timestamp override payload. + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000Z" + incident_id: 00000000-0000-0000-0000-000000000000 + modified_at: "2024-01-01T00:00:00.000Z" + timestamp_type: detected + timestamp_value: "2024-01-01T10:00:00.000Z" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_timestamp_overrides + schema: + $ref: "#/components/schemas/IncidentTimestampOverrideResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Create an incident timestamp override + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 84 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/incidents/{incident_id}/timestamp-overrides/{id}: + delete: + description: Delete a timestamp override for an incident. + operationId: DeleteTimestampOverride + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentTimestampOverrideIDPathParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000Z" + deleted_at: "2024-01-03T00:00:00.000Z" + incident_id: 00000000-0000-0000-0000-000000000000 + modified_at: "2024-01-01T00:00:00.000Z" + timestamp_type: detected + timestamp_value: "2024-01-01T10:00:00.000Z" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_timestamp_overrides + schema: + $ref: "#/components/schemas/IncidentTimestampOverrideResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Delete an incident timestamp override + tags: + - Incidents + x-menu-order: 86 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + patch: + description: Update a timestamp override for an incident. + operationId: UpdateTimestampOverride + parameters: + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentTimestampOverrideIDPathParameter" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + timestamp_value: "2024-01-01T11:00:00.000Z" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_timestamp_overrides + schema: + $ref: "#/components/schemas/IncidentTimestampOverridePatchRequest" + description: Timestamp override patch payload. + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000Z" + incident_id: 00000000-0000-0000-0000-000000000000 + modified_at: "2024-01-02T00:00:00.000Z" + timestamp_type: detected + timestamp_value: "2024-01-01T11:00:00.000Z" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_timestamp_overrides + schema: + $ref: "#/components/schemas/IncidentTimestampOverrideResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write + summary: Update an incident timestamp override + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 85 + x-permission: + operator: OR + permissions: + - incident_write + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/aws/accounts: get: description: Get a list of AWS Account Integration Configs. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index db47d9f215a..9a03110af72 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1884,6 +1884,50 @@ "request_description": "", "request_schema_description": "Request payload for updating global incident settings." }, + "CreateIncidentGoogleChatConfiguration": { + "description": "Create a Google Chat configuration for incidents.", + "summary": "Create an incident Google Chat configuration", + "request_description": "Google Chat configuration payload.", + "request_schema_description": "Request payload for creating a Google Chat configuration." + }, + "UpdateIncidentGoogleChatConfiguration": { + "description": "Update a Google Chat configuration for incidents.", + "summary": "Update an incident Google Chat configuration", + "request_description": "Google Chat configuration patch payload.", + "request_schema_description": "Request payload for patching a Google Chat configuration." + }, + "CreateIncidentGoogleMeetConfiguration": { + "description": "Create a Google Meet configuration for incidents.", + "summary": "Create an incident Google Meet configuration", + "request_description": "Google Meet configuration payload.", + "request_schema_description": "Request payload for creating a Google Meet configuration." + }, + "UpdateIncidentGoogleMeetConfiguration": { + "description": "Update a Google Meet configuration for incidents.", + "summary": "Update an incident Google Meet configuration", + "request_description": "Google Meet configuration patch payload.", + "request_schema_description": "Request payload for patching a Google Meet configuration." + }, + "ListIncidentImpactFields": { + "description": "List all impact fields for incidents.", + "summary": "List incident impact fields" + }, + "CreateIncidentImpactField": { + "description": "Create an impact field for incidents.", + "summary": "Create an incident impact field", + "request_description": "Impact field payload.", + "request_schema_description": "Request payload for creating an impact field." + }, + "DeleteIncidentImpactField": { + "description": "Delete an impact field for incidents.", + "summary": "Delete an incident impact field" + }, + "UpdateIncidentImpactField": { + "description": "Update an impact field for incidents.", + "summary": "Update an incident impact field", + "request_description": "Impact field update payload.", + "request_schema_description": "Request payload for creating an impact field." + }, "ListIncidentNotificationRules": { "description": "Lists all notification rules for the organization. Optionally filter by incident type.", "summary": "List incident notification rules" @@ -1956,6 +2000,30 @@ "request_description": "", "request_schema_description": "Request body for creating or updating a postmortem template." }, + "ListIncidentRules": { + "description": "List all incident rules.", + "summary": "List incident rules" + }, + "CreateIncidentRule": { + "description": "Create an incident rule.", + "summary": "Create an incident rule", + "request_description": "Incident rule payload.", + "request_schema_description": "Request payload for creating an incident rule." + }, + "DeleteIncidentRule": { + "description": "Delete an incident rule.", + "summary": "Delete an incident rule" + }, + "GetIncidentRule": { + "description": "Get a single incident rule by ID.", + "summary": "Get an incident rule" + }, + "UpdateIncidentRule": { + "description": "Update an incident rule.", + "summary": "Update an incident rule", + "request_description": "Incident rule patch payload.", + "request_schema_description": "Request payload for patching an incident rule." + }, "ListIncidentTypes": { "description": "Get all incident types.", "summary": "Get a list of incident types" @@ -1966,6 +2034,10 @@ "request_description": "Incident type payload.", "request_schema_description": "Create request for an incident type." }, + "ListOrgSettings": { + "description": "List org settings for all incident types.", + "summary": "List incident type org settings" + }, "DeleteIncidentType": { "description": "Delete an incident type.", "summary": "Delete an incident type" @@ -1980,6 +2052,10 @@ "request_description": "Incident type payload.", "request_schema_description": "Patch request for an incident type." }, + "GetOrgSettingsByIncidentType": { + "description": "Get the org settings for a specific incident type.", + "summary": "Get org settings by incident type" + }, "ListIncidentUserDefinedFields": { "description": "Get a list of all incident user-defined fields.", "summary": "Get a list of incident user-defined fields" @@ -2004,6 +2080,30 @@ "request_description": "Incident user-defined field update payload.", "request_schema_description": "Request body for updating an incident user-defined field." }, + "ListIncidentUserDefinedRoles": { + "description": "List all user-defined roles for incidents.", + "summary": "List incident user-defined roles" + }, + "CreateIncidentUserDefinedRole": { + "description": "Create a new user-defined role for incidents.", + "summary": "Create an incident user-defined role", + "request_description": "", + "request_schema_description": "Request for creating an incident user-defined role." + }, + "DeleteIncidentUserDefinedRole": { + "description": "Delete an existing user-defined role for incidents.", + "summary": "Delete an incident user-defined role" + }, + "GetIncidentUserDefinedRole": { + "description": "Retrieve a single user-defined role for incidents.", + "summary": "Get an incident user-defined role" + }, + "UpdateIncidentUserDefinedRole": { + "description": "Update an existing user-defined role for incidents.", + "summary": "Update an incident user-defined role", + "request_description": "", + "request_schema_description": "Request for updating an incident user-defined role." + }, "ImportIncident": { "description": "Import an incident from an external system. This endpoint allows you to create incidents with\nhistorical data such as custom timestamps for detection, declaration, and resolution.\nImported incidents do not execute integrations or notification rules.", "summary": "Import an incident", @@ -2028,6 +2128,10 @@ "request_description": "Incident Payload.", "request_schema_description": "Update request for an incident." }, + "GetIncidentAIPostmortem": { + "description": "Generate an AI postmortem for an incident.", + "summary": "Get an AI-generated incident postmortem" + }, "ListIncidentAttachments": { "description": "List incident attachments.", "summary": "List incident attachments" @@ -2052,6 +2156,24 @@ "request_description": "", "request_schema_description": "Request to update an attachment." }, + "CreatePageFromIncident": { + "description": "Create a page from an incident using the Cases service.", + "summary": "Create a page from an incident", + "request_description": "Page creation payload.", + "request_schema_description": "Request payload for creating a page from an incident." + }, + "UpdateIncidentConfiguration": { + "description": "Update a configuration for an incident.", + "summary": "Update an incident configuration", + "request_description": "Incident configuration patch payload.", + "request_schema_description": "Request payload for patching an incident configuration." + }, + "CreateIncidentConfiguration": { + "description": "Create a configuration for an incident.", + "summary": "Create an incident configuration", + "request_description": "Incident configuration payload.", + "request_schema_description": "Request payload for creating an incident configuration." + }, "ListIncidentImpacts": { "description": "Get all impacts for an incident.", "summary": "List an incident's impacts" @@ -2066,6 +2188,30 @@ "description": "Delete an incident impact.", "summary": "Delete an incident impact" }, + "PatchIncidentImpact": { + "description": "Partially update an incident impact.", + "summary": "Patch an incident impact", + "request_description": "Incident impact patch payload.", + "request_schema_description": "Create request for an incident impact." + }, + "UpdateIncidentImpact": { + "description": "Update an incident impact.", + "summary": "Update an incident impact", + "request_description": "Incident impact payload.", + "request_schema_description": "Create request for an incident impact." + }, + "CreateOnCallPageFromIncident": { + "description": "Create an on-call page directly from an incident.", + "summary": "Create an on-call page from an incident", + "request_description": "On-call page creation payload.", + "request_schema_description": "Request payload for creating an on-call page from an incident." + }, + "LinkPageToIncident": { + "description": "Link an existing on-call page to an incident.", + "summary": "Link a page to an incident", + "request_description": "On-call page link payload.", + "request_schema_description": "Request payload for linking an on-call page to an incident." + }, "ListIncidentIntegrations": { "description": "Get all integration metadata for an incident.", "summary": "Get a list of an incident's integration metadata" @@ -2114,6 +2260,50 @@ "request_description": "Incident todo payload.", "request_schema_description": "Patch request for an incident todo." }, + "ListIncidentResponders": { + "description": "List all responders for an incident.", + "summary": "List incident responders" + }, + "CreateIncidentResponder": { + "description": "Add a responder to an incident.", + "summary": "Create an incident responder", + "request_description": "Incident responder payload.", + "request_schema_description": "Request payload for creating an incident responder." + }, + "DeleteIncidentResponder": { + "description": "Remove a responder from an incident.", + "summary": "Delete an incident responder" + }, + "GetIncidentResponder": { + "description": "Get a single responder for an incident.", + "summary": "Get an incident responder" + }, + "CreateIncidentServiceNowRecord": { + "description": "Create a ServiceNow record for an incident.", + "summary": "Create an incident ServiceNow record", + "request_description": "ServiceNow record payload.", + "request_schema_description": "Request payload for creating a ServiceNow record for an incident." + }, + "ListTimestampOverrides": { + "description": "List all timestamp overrides for an incident.", + "summary": "List incident timestamp overrides" + }, + "CreateTimestampOverride": { + "description": "Create a timestamp override for an incident.", + "summary": "Create an incident timestamp override", + "request_description": "Timestamp override payload.", + "request_schema_description": "Request payload for creating a timestamp override." + }, + "DeleteTimestampOverride": { + "description": "Delete a timestamp override for an incident.", + "summary": "Delete an incident timestamp override" + }, + "UpdateTimestampOverride": { + "description": "Update a timestamp override for an incident.", + "summary": "Update an incident timestamp override", + "request_description": "Timestamp override patch payload.", + "request_schema_description": "Request payload for patching a timestamp override." + }, "ListAWSAccounts": { "description": "Get a list of AWS Account Integration Configs.", "summary": "List all AWS integrations"