Mark a deployment as failed by ID
PATCH
https://api.datadoghq.com/api/v2/dora/deployments/{deployment_id}https://api.us3.datadoghq.com/api/v2/dora/deployments/{deployment_id}https://api.us5.datadoghq.com/api/v2/dora/deployments/{deployment_id}https://api.datadoghq.eu/api/v2/dora/deployments/{deployment_id}https://api.ap1.datadoghq.com/api/v2/dora/deployments/{deployment_id}https://api.ap2.datadoghq.com/api/v2/dora/deployments/{deployment_id}https://api.uk1.datadoghq.com/api/v2/dora/deployments/{deployment_id}https://api.ddog-gov.com/api/v2/dora/deployments/{deployment_id}https://api.us2.ddog-gov.com/api/v2/dora/deployments/{deployment_id}Descripción general
Update a deployment's change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation.
Argumentos
Parámetros de ruta
Nombre
Type
Descripción
deployment_id [required]string
The ID of the deployment event.
Solicitud
Body Data (required)
Campo
Type
Descripción
data [required]object
The JSON:API data for patching a deployment.
attributes [required]object
Attributes for patching a DORA deployment event.
change_failureboolean
Indicates whether the deployment resulted in a change failure.
remediationobject
Remediation details for the deployment. Optional, but required to calculate failed deployment recovery time. Specify either id or version to identify the remediation deployment, but not both.
idstring
The ID of the remediation deployment. Use this or version to identify the remediation deployment, but not both.
typeenum
The type of remediation action taken. Required when the failed deployment must be linked to a remediation deployment.
Allowed enum values:
rollback, rollforwardversionstring
The version of the remediation deployment, matched against the same service and environment as the failed deployment. Use this or id to identify the remediation deployment, but not both.
id [required]string
The ID of the deployment to patch.
type [required]enum
JSON:API type for DORA deployment patch request.
dora_deployment_patch_requestAllowed enum values:
dora_deployment_patch_request{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback",
"version": "v1.2.4"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}Respuesta
Accepted
Bad Request
API error response.
Campo
Type
Descripción
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.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
Mark a deployment as failed by ID
# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF# Path parameters
export deployment_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/dora/deployments/${deployment_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"change_failure": true,
"remediation": {
"id": "eG42zNIkVjM",
"type": "rollback"
}
},
"id": "z_RwVLi7v4Y",
"type": "dora_deployment_patch_request"
}
}
EOF