--- title: Get a list of deployment events description: Use this API endpoint to get a list of deployment events. breadcrumbs: Docs > API > Get a list of deployment events --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get a list of deployment events ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------- | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/dora/deployments | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/dora/deployments | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/dora/deployments | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/dora/deployments | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/dora/deployments | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/dora/deployments | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/dora/deployments | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/dora/deployments | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/dora/deployments | ### Overview Use this API endpoint to get a list of deployment events. This endpoint requires the `dora_metrics_read` permission. ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | The JSON:API data. | | data | attributes [*required*] | object | Attributes to get a list of deployments. | | attributes | from | date-time | Minimum timestamp for requested events. | | attributes | limit | int32 | Maximum number of events in the response. Default: `10`. | | attributes | query | string | Search query with event platform syntax. | | attributes | sort | string | Sort order (prefixed with `-` for descending). | | attributes | to | date-time | Maximum timestamp for requested events. | | data | type | enum | The definition of `DORAListDeploymentsRequestDataType` object. Allowed enum values: `dora_deployments_list_request`. Default: `dora_deployments_list_request`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "from": "2023-08-31T00:00:00Z", "to": "2023-09-01T00:00:00Z" }, "type": "dora_deployments_list_request" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response for the list deployments endpoint. | Parent field | Field | Type | Description | | ------------ | -------------------------- | --------- | ------------------------------------------------------------------------------------------------------------- | | | data | [object] | The list of DORA deployment events. | | data | attributes | object | The attributes of the deployment event. | | attributes | 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. | | attributes | env | string | Environment name to where the service was deployed. | | attributes | finished_at | date-time | The time when the deployment finished. | | attributes | git | object | Git info returned by DORA Metrics events. | | git | commit_sha [*required*] | string | Git Commit SHA. | | git | repository_id [*required*] | string | Git Repository ID | | attributes | service [*required*] | string | Service name. | | attributes | started_at [*required*] | date-time | The time when the deployment started. | | attributes | team | string | Name of the team owning the deployed service. | | attributes | version | string | Version to correlate with APM Deployment Tracking. | | data | id | string | The ID of the deployment event. | | data | type | enum | JSON:API type for DORA deployment events. Allowed enum values: `dora_deployment`. Default: `dora_deployment`. | {% /tab %} {% tab label="Example" %} ```json { "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" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Not Authorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_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 ``` {% /tab %} {% /tabs %}