Obtenir un événement d'incident
GET
https://api.datadoghq.com/api/v2/dora/failures/{failure_id}https://api.us3.datadoghq.com/api/v2/dora/failures/{failure_id}https://api.us5.datadoghq.com/api/v2/dora/failures/{failure_id}https://api.datadoghq.eu/api/v2/dora/failures/{failure_id}https://api.ap1.datadoghq.com/api/v2/dora/failures/{failure_id}https://api.ap2.datadoghq.com/api/v2/dora/failures/{failure_id}https://api.uk1.datadoghq.com/api/v2/dora/failures/{failure_id}https://api.ddog-gov.com/api/v2/dora/failures/{failure_id}https://api.us2.ddog-gov.com/api/v2/dora/failures/{failure_id}Présentation
Utilisez cet endpoint d'API pour récupérer un événement d'incident.
Arguments
Paramètres du chemin
Name
Type
Description
failure_id [required]string
The ID of the incident event.
Réponse
OK
Response for fetching a single incident event.
Champ
Type
Description
dataobject
A DORA incident event.
attributesobject
The attributes of the incident event.
custom_tags[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
envstring
Environment name that was impacted by the incident.
finished_atdate-time
The time when the incident finished.
gitobject
Git info for DORA Metrics events.
commit_sha [required]string
Git Commit SHA.
repository_url [required]string
Git Repository URL
namestring
Incident name.
services[string]
Service names impacted by the incident.
severitystring
Incident severity.
started_atdate-time
The time when the incident started.
teamstring
Name of the team owning the services impacted.
versionstring
Version to correlate with APM Deployment Tracking.
idstring
The ID of the incident event.
typeenum
JSON:API type for DORA incident events.
dora_failureAllowed enum values:
dora_failure{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "production",
"finished_at": "2023-08-31T14:26:24Z",
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Database outage",
"services": [
"shopist"
],
"severity": "SEV-1",
"started_at": "2023-08-31T14:26:14Z",
"team": "backend",
"version": "v1.12.07"
},
"id": "string",
"type": "dora_failure"
}
}Bad Request
API error response.
Champ
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Authorized
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
Obtenir un événement d'incident
# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export failure_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 GET "https://api.${DD_SITE}/api/v2/dora/failures/${failure_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"