diff --git a/.apigentools-info b/.apigentools-info index 7a024f723bfa0..8e8cf98a9e12d 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-28 18:38:56.326868", - "spec_repo_commit": "b4ad1786" + "regenerated": "2024-10-28 23:09:04.590467", + "spec_repo_commit": "4251a422" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-28 18:39:04.239857", - "spec_repo_commit": "b4ad1786" + "regenerated": "2024-10-28 23:09:13.183062", + "spec_repo_commit": "4251a422" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index e7f501e4e09c3..153a73bb6b6ac 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -5791,6 +5791,71 @@ menu: unstable: - v2 order: 6 + - name: Update an incident type + url: '#update-an-incident-type' + identifier: incidents-update-an-incident-type + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - UpdateIncidentType + unstable: + - v2 + order: 22 + - name: Get incident type details + url: '#get-incident-type-details' + identifier: incidents-get-incident-type-details + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - GetIncidentType + unstable: + - v2 + order: 21 + - name: Delete an incident type + url: '#delete-an-incident-type' + identifier: incidents-delete-an-incident-type + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - DeleteIncidentType + unstable: + - v2 + order: 23 + - name: Create an incident type + url: '#create-an-incident-type' + identifier: incidents-create-an-incident-type + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - CreateIncidentType + unstable: + - v2 + order: 19 + - name: Get a list of incident types + url: '#get-a-list-of-incident-types' + identifier: incidents-get-a-list-of-incident-types + parent: incidents + generated: true + params: + versions: + - v2 + operationids: + - ListIncidentTypes + unstable: + - v2 + order: 20 - name: Create an incident url: '#create-an-incident' identifier: incidents-create-an-incident diff --git a/content/en/api/v2/incidents/examples.json b/content/en/api/v2/incidents/examples.json index 541b2d9cb2ad1..39b257732ae3b 100644 --- a/content/en/api/v2/incidents/examples.json +++ b/content/en/api/v2/incidents/examples.json @@ -18,6 +18,7 @@ "fields": { "": "undefined" }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "modified": "2019-09-19T10:00:00.000Z", "non_datadog_creator": { "image_48_px": "string", @@ -125,7 +126,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incidents.

\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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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

An array of incidents.

\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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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": { @@ -192,6 +193,7 @@ "fields": { "": "undefined" }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "modified": "2019-09-19T10:00:00.000Z", "non_datadog_creator": { "image_48_px": "string", @@ -291,7 +293,7 @@ } ] }, - "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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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 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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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": { @@ -360,6 +362,7 @@ "fields": { "": "undefined" }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "initial_cells": [ { "cell_type": "markdown", @@ -388,7 +391,354 @@ "type": "incidents" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident data for a create request.

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

attributes [required]

\n
\n

object

\n

The incident's attributes for a create request.

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

customer_impact_scope

\n
\n

string

\n

Required if customer_impacted:"true". A summary of the impact customers experienced during the incident.

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

customer_impacted [required]

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\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

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

initial_cells

\n
\n

[ <oneOf>]

\n

An array of initial timeline cells to be placed at the beginning of the incident timeline.

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

Option 1

\n
\n

object

\n

Timeline cell data for Markdown timeline cells for a create request.

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

cell_type [required]

\n
\n

enum

\n

Type of the Markdown timeline cell. \nAllowed enum values: markdown

default: markdown

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

content [required]

\n
\n

object

\n

The Markdown timeline cell contents.

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

content

\n
\n

string

\n

The Markdown content of the cell.

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

important

\n
\n

boolean

\n

A flag indicating whether the timeline cell is important and should be highlighted.

\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 at creation.

\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 [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

relationships

\n
\n

object

\n

The relationships the incident will have with other resources once created.

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

commander_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

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 data for a create request.

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

attributes [required]

\n
\n

object

\n

The incident's attributes for a create request.

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

customer_impact_scope

\n
\n

string

\n

Required if customer_impacted:"true". A summary of the impact customers experienced during the incident.

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

customer_impacted [required]

\n
\n

boolean

\n

A flag indicating whether the incident caused customer impact.

\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

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. The default incident type will be used if this property is not provided.

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

initial_cells

\n
\n

[ <oneOf>]

\n

An array of initial timeline cells to be placed at the beginning of the incident timeline.

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

Option 1

\n
\n

object

\n

Timeline cell data for Markdown timeline cells for a create request.

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

cell_type [required]

\n
\n

enum

\n

Type of the Markdown timeline cell. \nAllowed enum values: markdown

default: markdown

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

content [required]

\n
\n

object

\n

The Markdown timeline cell contents.

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

content

\n
\n

string

\n

The Markdown content of the cell.

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

important

\n
\n

boolean

\n

A flag indicating whether the timeline cell is important and should be highlighted.

\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 at creation.

\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 [required]

\n
\n

string

\n

The title of the incident, which summarizes what happened.

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

relationships

\n
\n

object

\n

The relationships the incident will have with other resources once created.

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

commander_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

Incident resource type. \nAllowed enum values: incidents

default: incidents

\n
\n \n
\n
\n
\n
" + } + }, + "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": true, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "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

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": { + "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": true, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "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

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": { + "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": true, + "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
" + } + }, + "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": true, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "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

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": true, + "lastModifiedBy": "00000000-0000-0000-0000-000000000000", + "modifiedAt": "2019-09-19T10:00:00.000Z", + "name": "Security Incident", + "prefix": "IR" + }, + "id": "00000000-0000-0000-0000-000000000000", + "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

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": true, + "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
" } }, "SearchIncidents": { @@ -508,6 +858,7 @@ "fields": { "": "undefined" }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "modified": "2019-09-19T10:00:00.000Z", "non_datadog_creator": { "image_48_px": "string", @@ -620,7 +971,7 @@ } } }, - "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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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

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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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": { @@ -736,6 +1087,7 @@ "fields": { "": "undefined" }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "modified": "2019-09-19T10:00:00.000Z", "non_datadog_creator": { "image_48_px": "string", @@ -835,7 +1187,7 @@ } ] }, - "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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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 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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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": { @@ -902,6 +1254,7 @@ "fields": { "": "undefined" }, + "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "modified": "2019-09-19T10:00:00.000Z", "non_datadog_creator": { "image_48_px": "string", @@ -1001,7 +1354,7 @@ } ] }, - "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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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 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

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

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-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

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

A single incident attachment.

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

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

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

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

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

attachment [required]

\n
\n

object

\n

The postmortem attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

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

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

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

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

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

attachment [required]

\n
\n

object

\n

The link attachment.

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

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

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

title [required]

\n
\n

string

\n

The title of this link attachment.

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

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

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

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

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

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\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": { diff --git a/content/en/api/v2/incidents/request.CreateIncidentType.json b/content/en/api/v2/incidents/request.CreateIncidentType.json new file mode 100644 index 0000000000000..c68a392d5a612 --- /dev/null +++ b/content/en/api/v2/incidents/request.CreateIncidentType.json @@ -0,0 +1,10 @@ +{ + "data": { + "attributes": { + "description": "8d4bbb66dccf2456", + "is_default": true, + "name": "8d4bbb66dccf2456" + }, + "type": "incident_types" + } +} \ No newline at end of file diff --git a/content/en/api/v2/incidents/request.UpdateIncidentType.json b/content/en/api/v2/incidents/request.UpdateIncidentType.json new file mode 100644 index 0000000000000..edaecd710995a --- /dev/null +++ b/content/en/api/v2/incidents/request.UpdateIncidentType.json @@ -0,0 +1,9 @@ +{ + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "attributes": { + "name": "Security Incident-updated" + }, + "type": "incident_types" + } +} \ No newline at end of file diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index a6c700e6141a3..46dd8e142c439 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -23508,6 +23508,7 @@ components: incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. + incident_settings_read: View Incident Settings. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. diff --git a/data/api/v1/full_spec_deref.json b/data/api/v1/full_spec_deref.json index 467d3557cfb71..283e07c3e94c3 100644 --- a/data/api/v1/full_spec_deref.json +++ b/data/api/v1/full_spec_deref.json @@ -666384,6 +666384,7 @@ "hosts_read": "List hosts and their attributes.", "incident_notification_settings_write": "Configure Incidents Notification settings.", "incident_read": "View incidents in Datadog.", + "incident_settings_read": "View Incident Settings.", "incident_settings_write": "Configure Incident Settings.", "incident_write": "Create, view, and manage incidents in Datadog.", "metrics_read": "View custom metrics.", diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 1dc0b96c075f3..06c7dc8917689 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -457,6 +457,13 @@ "description": "Create an incident todo returns \"CREATED\" response" } ], + "CreateIncidentType": [ + { + "group": "incidents", + "suffix": "", + "description": "Create an incident type returns \"CREATED\" response" + } + ], "UpdateIncidentIntegration": [ { "group": "incidents", @@ -471,6 +478,13 @@ "description": "Update an incident todo returns \"OK\" response" } ], + "UpdateIncidentType": [ + { + "group": "incidents", + "suffix": "", + "description": "Update an incident type returns \"OK\" response" + } + ], "CreateAPIKey": [ { "group": "key_management", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 3df7326366dd2..0e89d8f65fb01 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -433,6 +433,20 @@ components: required: true schema: type: string + IncidentTypeIDPathParameter: + description: The UUID of the incident type. + in: path + name: incident_type_id + required: true + schema: + type: string + IncidentTypeIncludeDeletedParameter: + description: Include deleted incident types in the response. + in: query + name: include_deleted + schema: + default: false + type: boolean Include: description: Include relationship data. explode: true @@ -10575,6 +10589,11 @@ components: type: dropdown value: SEV-5 type: object + incident_type_uuid: + description: A unique identifier that represents an incident type. The default + incident type will be used if this property is not provided. + example: 00000000-0000-0000-0000-000000000000 + type: string initial_cells: description: An array of initial timeline cells to be placed at the beginning of the incident timeline. @@ -10984,6 +11003,10 @@ components: type: dropdown value: SEV-5 type: object + incident_type_uuid: + description: A unique identifier that represents an incident type. + example: 00000000-0000-0000-0000-000000000000 + type: string modified: description: Timestamp when the incident was last modified. format: date-time @@ -11931,6 +11954,188 @@ components: type: string x-enum-varnames: - INCIDENTS + IncidentTypeAttributes: + description: Incident type's attributes. + properties: + createdAt: + description: Timestamp when the incident type was created. + format: date-time + readOnly: true + type: string + createdBy: + description: A unique identifier that represents the user that created the + incident type. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + type: string + description: + description: Text that describes the incident type. + example: Any incidents that harm (or have the potential to) the confidentiality, + integrity, or availability of our data. + type: string + is_default: + default: false + description: 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. + example: true + type: boolean + lastModifiedBy: + description: A unique identifier that represents the user that last modified + the incident type. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + type: string + modifiedAt: + description: Timestamp when the incident type was last modified. + format: date-time + readOnly: true + type: string + name: + description: The name of the incident type. + example: Security Incident + type: string + prefix: + description: The string that will be prepended to the incident title across + the Datadog app. + example: IR + readOnly: true + type: string + required: + - name + type: object + IncidentTypeCreateData: + description: Incident type data for a create request. + properties: + attributes: + $ref: '#/components/schemas/IncidentTypeAttributes' + type: + $ref: '#/components/schemas/IncidentTypeType' + required: + - type + - attributes + type: object + IncidentTypeCreateRequest: + description: Create request for an incident type. + properties: + data: + $ref: '#/components/schemas/IncidentTypeCreateData' + required: + - data + type: object + IncidentTypeListResponse: + description: Response with a list of incident types. + properties: + data: + description: An array of incident type objects. + items: + $ref: '#/components/schemas/IncidentTypeObject' + type: array + required: + - data + type: object + IncidentTypeObject: + description: Incident type response data. + properties: + attributes: + $ref: '#/components/schemas/IncidentTypeAttributes' + id: + description: The incident type's ID. + example: 00000000-0000-0000-0000-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentTypeType' + required: + - id + - type + type: object + IncidentTypePatchData: + description: Incident type data for a patch request. + properties: + attributes: + $ref: '#/components/schemas/IncidentTypeUpdateAttributes' + id: + description: The incident type's ID. + example: 00000000-0000-0000-0000-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentTypeType' + required: + - id + - type + - attributes + type: object + IncidentTypePatchRequest: + description: Patch request for an incident type. + properties: + data: + $ref: '#/components/schemas/IncidentTypePatchData' + required: + - data + type: object + IncidentTypeResponse: + description: Incident type response data. + properties: + data: + $ref: '#/components/schemas/IncidentTypeObject' + required: + - data + type: object + IncidentTypeType: + default: incident_types + description: Incident type resource type. + enum: + - incident_types + example: incident_types + type: string + x-enum-varnames: + - INCIDENT_TYPES + IncidentTypeUpdateAttributes: + description: Incident type's attributes for updates. + properties: + createdAt: + description: Timestamp when the incident type was created. + format: date-time + readOnly: true + type: string + createdBy: + description: A unique identifier that represents the user that created the + incident type. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + type: string + description: + description: Text that describes the incident type. + example: 'Any incidents that harm (or have the potential to) the confidentiality, + integrity, or availability of our data. Note: This will notify the security + team.' + type: string + is_default: + description: When true, this incident type will be used as the default type + when an incident type is not specified. + example: true + type: boolean + lastModifiedBy: + description: A unique identifier that represents the user that last modified + the incident type. + example: 00000000-0000-0000-0000-000000000000 + readOnly: true + type: string + modifiedAt: + description: Timestamp when the incident type was last modified. + format: date-time + readOnly: true + type: string + name: + description: The name of the incident type. + example: Security Incident + type: string + prefix: + description: The string that will be prepended to the incident title across + the Datadog app. + example: IR + readOnly: true + type: string + type: object IncidentUpdateAttributes: description: The incident's attributes for an update request. properties: @@ -12074,6 +12279,7 @@ components: customer_impact_start: null customer_impacted: false detected: '2020-04-14T00:00:00+00:00' + incident_type_uuid: 00000000-0000-0000-0000-000000000001 modified: '2020-09-17T14:16:58.696424+00:00' public_id: 1 resolved: null @@ -12119,6 +12325,7 @@ components: customer_impact_start: null customer_impacted: false detected: '2020-04-14T00:00:00+00:00' + incident_type_uuid: 00000000-0000-0000-0000-000000000002 modified: '2020-09-17T14:16:58.696424+00:00' public_id: 2 resolved: null @@ -26100,6 +26307,7 @@ components: incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. + incident_settings_read: View Incident Settings. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. @@ -30732,6 +30940,232 @@ paths: type: unsafe 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: + get: + description: Get all incident types. + operationId: ListIncidentTypes + parameters: + - $ref: '#/components/parameters/IncidentTypeIncludeDeletedParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypeListResponse' + 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 + - incident_read + summary: Get a list of incident types + tags: + - Incidents + x-menu-order: 20 + x-permission: + operator: OR + permissions: + - incident_settings_read + - incident_read + x-undo: + type: safe + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + post: + description: Create an incident type. + operationId: CreateIncidentType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypeCreateRequest' + description: Incident type payload. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypeResponse' + 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_settings_write + summary: Create an incident type + tags: + - Incidents + x-codegen-request-body-name: body + x-given: + incident_type: + parameters: + - name: body + value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{unique_hash}}\"\n + \ },\n \"type\": \"incident_types\"\n }\n}" + step: there is a valid "incident_type" in the system + x-menu-order: 19 + x-permission: + operator: OR + permissions: + - incident_settings_write + x-undo: + operationId: DeleteIncidentType + parameters: + - name: incident_type_id + source: data.id + type: unsafe + 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}: + delete: + description: Delete an incident type. + operationId: DeleteIncidentType + parameters: + - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + responses: + '204': + 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_settings_write + summary: Delete an incident type + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 23 + x-permission: + operator: OR + permissions: + - incident_settings_write + x-undo: + type: idempotent + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + get: + description: Get incident type details. + operationId: GetIncidentType + parameters: + - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypeResponse' + 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_settings_read + - incident_read + summary: Get incident type details + tags: + - Incidents + x-menu-order: 21 + x-permission: + operator: OR + permissions: + - incident_settings_read + - incident_read + x-undo: + type: safe + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + patch: + description: Update an incident type. + operationId: UpdateIncidentType + parameters: + - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypePatchRequest' + description: Incident type payload. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypeResponse' + 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_settings_write + summary: Update an incident type + tags: + - Incidents + x-codegen-request-body-name: body + x-menu-order: 22 + x-permission: + operator: OR + permissions: + - incident_settings_write + x-undo: + type: idempotent + 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/search: get: diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index bb9fc233df637..8e3967eb9f4ef 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -663,6 +663,24 @@ "type": "string" } }, + "IncidentTypeIDPathParameter": { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + }, + "IncidentTypeIncludeDeletedParameter": { + "description": "Include deleted incident types in the response.", + "in": "query", + "name": "include_deleted", + "schema": { + "default": false, + "type": "boolean" + } + }, "Include": { "description": "Include relationship data.", "explode": true, @@ -55938,6 +55956,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -56128,6 +56151,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -56443,6 +56471,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -59997,6 +60030,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -60910,6 +60948,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -61183,6 +61226,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -62901,6 +62949,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -64275,6 +64328,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -65353,6 +65411,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -66463,6 +66526,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -73501,6 +73569,722 @@ "INCIDENTS" ] }, + "IncidentTypeAttributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "IncidentTypeCreateData": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + }, + "IncidentTypeCreateRequest": { + "description": "Create request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeListResponse": { + "description": "Response with a list of incident types.", + "properties": { + "data": { + "description": "An array of incident type objects.", + "items": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeObject": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IncidentTypePatchData": { + "description": "Incident type data for a patch request.", + "properties": { + "attributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IncidentTypePatchRequest": { + "description": "Patch request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a patch request.", + "properties": { + "attributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeResponse": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeType": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + }, + "IncidentTypeUpdateAttributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "IncidentUpdateAttributes": { "description": "The incident's attributes for an update request.", "properties": { @@ -74609,6 +75393,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000001", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 1, "resolved": null, @@ -74676,6 +75461,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000002", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 2, "resolved": null, @@ -74869,6 +75655,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -169180,6 +169971,7 @@ "hosts_read": "List hosts and their attributes.", "incident_notification_settings_write": "Configure Incidents Notification settings.", "incident_read": "View incidents in Datadog.", + "incident_settings_read": "View Incident Settings.", "incident_settings_write": "Configure Incident Settings.", "incident_write": "Create, view, and manage incidents in Datadog.", "metrics_read": "View custom metrics.", @@ -212437,6 +213229,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000001", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 1, "resolved": null, @@ -212504,6 +213297,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000002", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 2, "resolved": null, @@ -212697,6 +213491,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -213788,6 +214587,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -214112,6 +214916,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -215041,42 +215850,1536 @@ }, { "AuthZ": [ - "incident_write" + "incident_write" + ] + } + ], + "summary": "Create an incident", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" + } + ], + "step": "there is a valid \"incident\" in the system" + } + }, + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncident", + "parameters": [ + { + "name": "incident_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/config/types": { + "get": { + "description": "Get all incident types.", + "operationId": "ListIncidentTypes", + "parameters": [ + { + "description": "Include deleted incident types in the response.", + "in": "query", + "name": "include_deleted", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident types.", + "properties": { + "data": { + "description": "An array of incident type objects.", + "items": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_read", + "incident_read" + ] + } + ], + "summary": "Get a list of incident types", + "tags": [ + "Incidents" + ], + "x-menu-order": 20, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_read", + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create an incident type.", + "operationId": "CreateIncidentType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident type payload.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "CREATED" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_write" + ] + } + ], + "summary": "Create an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident_type": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{unique_hash}}\"\n },\n \"type\": \"incident_types\"\n }\n}" + } + ], + "step": "there is a valid \"incident_type\" in the system" + } + }, + "x-menu-order": 19, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncidentType", + "parameters": [ + { + "name": "incident_type_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf 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.", + "operationId": "DeleteIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_write" + ] + } + ], + "summary": "Delete an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 23, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Get incident type details.", + "operationId": "GetIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_read", + "incident_read" ] } ], - "summary": "Create an incident", + "summary": "Get incident type details", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-given": { - "incident": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" + "x-menu-order": 21, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_read", + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "patch": { + "description": "Update an incident type.", + "operationId": "UpdateIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Patch request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a patch request.", + "properties": { + "attributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" } - ], - "step": "there is a valid \"incident\" in the system" + } + }, + "description": "Incident type payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" } }, - "x-menu-order": 1, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_write" + ] + } + ], + "summary": "Update an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 22, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "incident_settings_write" ] }, "x-undo": { - "operationId": "DeleteIncident", - "parameters": [ - { - "name": "incident_id", - "source": "data.id" - } - ], - "type": "unsafe" + "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } @@ -215696,6 +217999,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -217089,6 +219397,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -218578,6 +220891,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index f0f2113cf0c24..d93a8e3028b87 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -457,6 +457,30 @@ "request_description": "Incident payload.", "request_schema_description": "Create request for an incident." }, + "ListIncidentTypes": { + "description": "Get all incident types.", + "summary": "Get a list of incident types" + }, + "CreateIncidentType": { + "description": "Create an incident type.", + "summary": "Create an incident type", + "request_description": "Incident type payload.", + "request_schema_description": "Create request for an incident type." + }, + "DeleteIncidentType": { + "description": "Delete an incident type.", + "summary": "Delete an incident type" + }, + "GetIncidentType": { + "description": "Get incident type details.", + "summary": "Get incident type details" + }, + "UpdateIncidentType": { + "description": "Update an incident type.", + "summary": "Update an incident type", + "request_description": "Incident type payload.", + "request_schema_description": "Patch request for an incident type." + }, "SearchIncidents": { "description": "Search for incidents matching a certain query.", "summary": "Search for incidents" diff --git a/static/resources/json/full_spec_v1.json b/static/resources/json/full_spec_v1.json index 467d3557cfb71..283e07c3e94c3 100644 --- a/static/resources/json/full_spec_v1.json +++ b/static/resources/json/full_spec_v1.json @@ -666384,6 +666384,7 @@ "hosts_read": "List hosts and their attributes.", "incident_notification_settings_write": "Configure Incidents Notification settings.", "incident_read": "View incidents in Datadog.", + "incident_settings_read": "View Incident Settings.", "incident_settings_write": "Configure Incident Settings.", "incident_write": "Create, view, and manage incidents in Datadog.", "metrics_read": "View custom metrics.", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index bb9fc233df637..8e3967eb9f4ef 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -663,6 +663,24 @@ "type": "string" } }, + "IncidentTypeIDPathParameter": { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + }, + "IncidentTypeIncludeDeletedParameter": { + "description": "Include deleted incident types in the response.", + "in": "query", + "name": "include_deleted", + "schema": { + "default": false, + "type": "boolean" + } + }, "Include": { "description": "Include relationship data.", "explode": true, @@ -55938,6 +55956,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -56128,6 +56151,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -56443,6 +56471,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -59997,6 +60030,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -60910,6 +60948,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -61183,6 +61226,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -62901,6 +62949,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -64275,6 +64328,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -65353,6 +65411,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -66463,6 +66526,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -73501,6 +73569,722 @@ "INCIDENTS" ] }, + "IncidentTypeAttributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "IncidentTypeCreateData": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + }, + "IncidentTypeCreateRequest": { + "description": "Create request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeListResponse": { + "description": "Response with a list of incident types.", + "properties": { + "data": { + "description": "An array of incident type objects.", + "items": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeObject": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IncidentTypePatchData": { + "description": "Incident type data for a patch request.", + "properties": { + "attributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IncidentTypePatchRequest": { + "description": "Patch request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a patch request.", + "properties": { + "attributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeResponse": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IncidentTypeType": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + }, + "IncidentTypeUpdateAttributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "IncidentUpdateAttributes": { "description": "The incident's attributes for an update request.", "properties": { @@ -74609,6 +75393,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000001", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 1, "resolved": null, @@ -74676,6 +75461,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000002", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 2, "resolved": null, @@ -74869,6 +75655,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -169180,6 +169971,7 @@ "hosts_read": "List hosts and their attributes.", "incident_notification_settings_write": "Configure Incidents Notification settings.", "incident_read": "View incidents in Datadog.", + "incident_settings_read": "View Incident Settings.", "incident_settings_write": "Configure Incident Settings.", "incident_write": "Create, view, and manage incidents in Datadog.", "metrics_read": "View custom metrics.", @@ -212437,6 +213229,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000001", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 1, "resolved": null, @@ -212504,6 +213297,7 @@ "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000002", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 2, "resolved": null, @@ -212697,6 +213491,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -213788,6 +214587,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "initial_cells": { "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", "items": { @@ -214112,6 +214916,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -215041,42 +215850,1536 @@ }, { "AuthZ": [ - "incident_write" + "incident_write" + ] + } + ], + "summary": "Create an incident", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" + } + ], + "step": "there is a valid \"incident\" in the system" + } + }, + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncident", + "parameters": [ + { + "name": "incident_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/config/types": { + "get": { + "description": "Get all incident types.", + "operationId": "ListIncidentTypes", + "parameters": [ + { + "description": "Include deleted incident types in the response.", + "in": "query", + "name": "include_deleted", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident types.", + "properties": { + "data": { + "description": "An array of incident type objects.", + "items": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_read", + "incident_read" + ] + } + ], + "summary": "Get a list of incident types", + "tags": [ + "Incidents" + ], + "x-menu-order": 20, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_read", + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create an incident type.", + "operationId": "CreateIncidentType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident type payload.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "CREATED" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_write" + ] + } + ], + "summary": "Create an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident_type": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{unique_hash}}\"\n },\n \"type\": \"incident_types\"\n }\n}" + } + ], + "step": "there is a valid \"incident_type\" in the system" + } + }, + "x-menu-order": 19, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncidentType", + "parameters": [ + { + "name": "incident_type_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf 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.", + "operationId": "DeleteIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_write" + ] + } + ], + "summary": "Delete an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 23, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Get incident type details.", + "operationId": "GetIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_read", + "incident_read" ] } ], - "summary": "Create an incident", + "summary": "Get incident type details", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-given": { - "incident": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" + "x-menu-order": 21, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_read", + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "patch": { + "description": "Update an incident type.", + "operationId": "UpdateIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Patch request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a patch request.", + "properties": { + "attributes": { + "description": "Incident type's attributes for updates.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" } - ], - "step": "there is a valid \"incident\" in the system" + } + }, + "description": "Incident type payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "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.", + "example": true, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" } }, - "x-menu-order": 1, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_write" + ] + } + ], + "summary": "Update an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 22, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "incident_settings_write" ] }, "x-undo": { - "operationId": "DeleteIncident", - "parameters": [ - { - "name": "incident_id", - "source": "data.id" - } - ], - "type": "unsafe" + "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } @@ -215696,6 +217999,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -217089,6 +219397,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time", @@ -218578,6 +220891,11 @@ }, "type": "object" }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, "modified": { "description": "Timestamp when the incident was last modified.", "format": "date-time",