Obtener una lista de eventos de despliegue
POST
https://api.datadoghq.com/api/v2/dora/deploymentshttps://api.us3.datadoghq.com/api/v2/dora/deploymentshttps://api.us5.datadoghq.com/api/v2/dora/deploymentshttps://api.datadoghq.eu/api/v2/dora/deploymentshttps://api.ap1.datadoghq.com/api/v2/dora/deploymentshttps://api.ap2.datadoghq.com/api/v2/dora/deploymentshttps://api.uk1.datadoghq.com/api/v2/dora/deploymentshttps://api.ddog-gov.com/api/v2/dora/deploymentshttps://api.us2.ddog-gov.com/api/v2/dora/deploymentsDescripción general
Utiliza este endpoint de la API para obtener una lista de eventos de despliegue.
Solicitud
Body Data (required)
Campo
Type
Descripción
data [required]object
Solicitud para obtener una lista de despliegues.
attributes [required]object
Attributes to get a list of deployments.
fromdate-time
Minimum timestamp for requested events.
limitint32
Maximum number of events in the response.
10querystring
Search query with event platform syntax.
sortstring
Sort order (prefixed with - for descending).
todate-time
Maximum timestamp for requested events.
typeenum
The definition of DORAListDeploymentsRequestDataType object.
dora_deployments_list_requestAllowed enum values:
dora_deployments_list_request{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}Respuesta
OK
Response for the list deployments endpoint.
Campo
Type
Descripción
data[object]
The list of DORA deployment events.
attributesobject
The attributes of the deployment 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 to where the service was deployed.
finished_atdate-time
The time when the deployment finished.
gitobject
Git info returned by DORA Metrics events.
commit_sha [required]string
Git Commit SHA.
repository_id [required]string
Git Repository ID
service [required]string
Service name.
started_at [required]date-time
The time when the deployment started.
teamstring
Name of the team owning the deployed service.
versionstring
Version to correlate with APM Deployment Tracking.
idstring
The ID of the deployment event.
typeenum
JSON:API type for DORA deployment events.
dora_deploymentAllowed enum values:
dora_deployment{
"data": [
{
"attributes": {
"custom_tags": [
"language:java",
"department:engineering",
"region:us-east-1"
],
"env": "production",
"finished_at": "2023-08-31T14:26:24Z",
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_id": "github.com/organization/example-repository"
},
"service": "shopist",
"started_at": "2023-08-31T14:26:14Z",
"team": "backend",
"version": "v1.12.07"
},
"id": "4242fcdd31586083",
"type": "dora_deployment"
},
{
"attributes": {
"custom_tags": [
"language:go",
"department:platform"
],
"env": "production",
"finished_at": "2023-08-31T14:28:04Z",
"git": {
"commit_sha": "77bdc9350f2cc9b250b69abddab733dd55e1a599",
"repository_id": "github.com/organization/api-service"
},
"service": "api-service",
"started_at": "2023-08-31T14:27:54Z",
"team": "backend",
"version": "v2.1.0"
},
"id": "4242fcdd31586084",
"type": "dora_deployment"
}
]
}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
Get a list of deployment events returns deployments with date-time timestamps
# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF# 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 POST "https://api.${DD_SITE}/api/v2/dora/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": "2023-08-31T00:00:00Z",
"to": "2023-09-01T00:00:00Z"
},
"type": "dora_deployments_list_request"
}
}
EOF