Update an incident configuration
WARNINGNote: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
PATCH
https://api.datadoghq.com/api/v2/incidents/{incident_id}/configurationshttps://api.us3.datadoghq.com/api/v2/incidents/{incident_id}/configurationshttps://api.us5.datadoghq.com/api/v2/incidents/{incident_id}/configurationshttps://api.datadoghq.eu/api/v2/incidents/{incident_id}/configurationshttps://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}/configurationshttps://api.ap2.datadoghq.com/api/v2/incidents/{incident_id}/configurationshttps://api.uk1.datadoghq.com/api/v2/incidents/{incident_id}/configurationshttps://api.ddog-gov.com/api/v2/incidents/{incident_id}/configurationshttps://api.us2.ddog-gov.com/api/v2/incidents/{incident_id}/configurationsPrésentation
Update a configuration for an incident.
OAuth apps require the incident_write authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Name
Type
Description
incident_id [required]string
The UUID of the incident.
Requête
Body Data (required)
Incident configuration patch payload.
Champ
Type
Description
data [required]object
Incident configuration data in a patch request.
attributesobject
Attributes for patching an incident configuration. All fields are optional.
execute_integrationsboolean
Whether to execute integrations for this incident.
execute_notification_rulesboolean
Whether to execute notification rules for this incident.
include_in_analyticsboolean
Whether to include this incident in analytics.
include_in_searchboolean
Whether to include this incident in search results.
id [required]uuid
The incident configuration identifier.
type [required]enum
Incident configuration resource type.
Allowed enum values:
incidents_configurations{
"data": {
"attributes": {
"execute_integrations": true,
"execute_notification_rules": true,
"include_in_analytics": true,
"include_in_search": true
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "incidents_configurations"
}
}Réponse
OK
Response with an incident configuration.
Champ
Type
Description
data [required]object
Incident configuration data in a response.
attributes [required]object
Attributes of an incident configuration in a response.
created_at [required]date-time
Timestamp when the configuration was created.
execute_integrationsboolean
Whether integrations are executed for this incident.
execute_notification_rulesboolean
Whether notification rules are executed for this incident.
incident_id [required]string
The incident identifier.
include_in_analyticsboolean
Whether this incident is included in analytics.
include_in_searchboolean
Whether this incident is included in search results.
modified_at [required]date-time
Timestamp when the configuration was last modified.
id [required]uuid
The incident configuration identifier.
relationshipsobject
Relationships for an incident configuration.
created_by_userobject
Relationship to user.
data [required]object
Relationship to user object.
id [required]string
A unique identifier that represents the user.
type [required]enum
Users resource type.
usersAllowed enum values:
userslast_modified_by_userobject
Relationship to user.
data [required]object
Relationship to user object.
id [required]string
A unique identifier that represents the user.
type [required]enum
Users resource type.
usersAllowed enum values:
userstype [required]enum
Incident configuration resource type.
Allowed enum values:
incidents_configurationsincluded[object]
Included related resources.
attributesobject
Attributes of user object returned by the API.
emailstring
Email of the user.
handlestring
Handle of the user.
iconstring
URL of the user's icon.
namestring
Name of the user.
uuidstring
UUID of the user.
idstring
ID of the user.
typeenum
Users resource type.
usersAllowed enum values:
users{
"data": {
"attributes": {
"created_at": "2024-01-01T00:00:00.000Z",
"execute_integrations": true,
"execute_notification_rules": true,
"incident_id": "00000000-0000-0000-0000-000000000000",
"include_in_analytics": true,
"include_in_search": true,
"modified_at": "2024-01-01T00:00:00.000Z"
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
}
},
"type": "incidents_configurations"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}Bad Request
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Unauthorized
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Exemple de code
Update an incident configuration
# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"include_in_search": false
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "incidents_configurations"
}
}
EOF