--- title: Get a list of deployment events description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > DORA Metrics --- # Get a list of deployment events{% #get-a-list-of-deployment-events %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------- | | 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 | | app.datadoghq.eu | POST https://api.datadoghq.eu/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 | | 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 | ### Overview Use this API endpoint to get a list of deployment events. This endpoint requires the `dora_metrics_read` permission. ### Request #### Body Data (required) {% tab title="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. | | 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` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "from": "2025-01-01T00:00:00Z", "limit": 500, "query": "service:(shopist OR api-service OR payment-service) env:(production OR staging) team:(backend OR platform)", "sort": "-finished_at", "to": "2025-01-31T23:59:59Z" }, "type": "dora_deployments_list_request" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="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 [*required*] | int64 | Unix timestamp 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*] | int64 | Unix timestamp 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` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "custom_tags": [ "language:java", "department:engineering", "region:us-east-1" ], "env": "production", "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_id": "github.com/organization/example-repository" }, "service": "shopist", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07" }, "id": "4242fcdd31586083", "type": "dora_deployment" }, { "attributes": { "custom_tags": [ "language:go", "department:platform" ], "env": "production", "finished_at": 1693492084000000000, "git": { "commit_sha": "77bdc9350f2cc9b250b69abddab733dd55e1a599", "repository_id": "github.com/organization/api-service" }, "service": "api-service", "started_at": 1693492074000000000, "team": "backend", "version": "v2.1.0" }, "id": "4242fcdd31586084", "type": "dora_deployment" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="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 title="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 %} {% /tab %} {% tab title="403" %} Not Authorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/dora/deployments" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "from": "2025-01-01T00:00:00Z", "limit": 100, "query": "service:(test-service OR api-service) env:production team:backend", "sort": "-finished_at", "to": "2025-01-31T23:59:59Z" }, "type": "dora_deployments_list_request" } } EOF ##### ```python """ Get a list of deployment events returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.dora_metrics_api import DORAMetricsApi from datadog_api_client.v2.model.dora_list_deployments_request import DORAListDeploymentsRequest from datadog_api_client.v2.model.dora_list_deployments_request_attributes import DORAListDeploymentsRequestAttributes from datadog_api_client.v2.model.dora_list_deployments_request_data import DORAListDeploymentsRequestData from datadog_api_client.v2.model.dora_list_deployments_request_data_type import DORAListDeploymentsRequestDataType from datetime import datetime from dateutil.tz import tzutc body = DORAListDeploymentsRequest( data=DORAListDeploymentsRequestData( attributes=DORAListDeploymentsRequestAttributes( _from=datetime(2025, 3, 23, 0, 0, tzinfo=tzutc()), limit=1, to=datetime(2025, 3, 24, 0, 0, tzinfo=tzutc()), ), type=DORAListDeploymentsRequestDataType.DORA_DEPLOYMENTS_LIST_REQUEST, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DORAMetricsApi(api_client) response = api_instance.list_dora_deployments(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a list of deployment events returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::DORAMetricsAPI.new body = DatadogAPIClient::V2::DORAListDeploymentsRequest.new({ data: DatadogAPIClient::V2::DORAListDeploymentsRequestData.new({ attributes: DatadogAPIClient::V2::DORAListDeploymentsRequestAttributes.new({ from: "2025-03-23T00:00:00Z", limit: 1, to: "2025-03-24T00:00:00Z", }), type: DatadogAPIClient::V2::DORAListDeploymentsRequestDataType::DORA_DEPLOYMENTS_LIST_REQUEST, }), }) p api_instance.list_dora_deployments(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a list of deployment events returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "time" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.DORAListDeploymentsRequest{ Data: datadogV2.DORAListDeploymentsRequestData{ Attributes: datadogV2.DORAListDeploymentsRequestAttributes{ From: datadog.PtrTime(time.Date(2025, 3, 23, 0, 0, 0, 0, time.UTC)), Limit: datadog.PtrInt32(1), To: datadog.PtrTime(time.Date(2025, 3, 24, 0, 0, 0, 0, time.UTC)), }, Type: datadogV2.DORALISTDEPLOYMENTSREQUESTDATATYPE_DORA_DEPLOYMENTS_LIST_REQUEST.Ptr(), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewDORAMetricsApi(apiClient) resp, r, err := api.ListDORADeployments(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DORAMetricsApi.ListDORADeployments`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DORAMetricsApi.ListDORADeployments`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a list of deployment events returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.DoraMetricsApi; import com.datadog.api.client.v2.model.DORADeploymentsListResponse; import com.datadog.api.client.v2.model.DORAListDeploymentsRequest; import com.datadog.api.client.v2.model.DORAListDeploymentsRequestAttributes; import com.datadog.api.client.v2.model.DORAListDeploymentsRequestData; import com.datadog.api.client.v2.model.DORAListDeploymentsRequestDataType; import java.time.OffsetDateTime; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DoraMetricsApi apiInstance = new DoraMetricsApi(defaultClient); DORAListDeploymentsRequest body = new DORAListDeploymentsRequest() .data( new DORAListDeploymentsRequestData() .attributes( new DORAListDeploymentsRequestAttributes() .from(OffsetDateTime.parse("2025-03-23T00:00:00Z")) .limit(1) .to(OffsetDateTime.parse("2025-03-24T00:00:00Z"))) .type(DORAListDeploymentsRequestDataType.DORA_DEPLOYMENTS_LIST_REQUEST)); try { DORADeploymentsListResponse result = apiInstance.listDORADeployments(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DoraMetricsApi#listDORADeployments"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get a list of deployment events returns "OK" response use chrono::{DateTime, Utc}; use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_dora_metrics::DORAMetricsAPI; use datadog_api_client::datadogV2::model::DORAListDeploymentsRequest; use datadog_api_client::datadogV2::model::DORAListDeploymentsRequestAttributes; use datadog_api_client::datadogV2::model::DORAListDeploymentsRequestData; use datadog_api_client::datadogV2::model::DORAListDeploymentsRequestDataType; #[tokio::main] async fn main() { let body = DORAListDeploymentsRequest::new( DORAListDeploymentsRequestData::new( DORAListDeploymentsRequestAttributes::new() .from( DateTime::parse_from_rfc3339("2025-03-23T00:00:00+00:00") .expect("Failed to parse datetime") .with_timezone(&Utc), ) .limit(1) .to(DateTime::parse_from_rfc3339("2025-03-24T00:00:00+00:00") .expect("Failed to parse datetime") .with_timezone(&Utc)), ) .type_(DORAListDeploymentsRequestDataType::DORA_DEPLOYMENTS_LIST_REQUEST), ); let configuration = datadog::Configuration::new(); let api = DORAMetricsAPI::with_config(configuration); let resp = api.list_dora_deployments(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a list of deployment events returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.DORAMetricsApi(configuration); const params: v2.DORAMetricsApiListDORADeploymentsRequest = { body: { data: { attributes: { from: new Date(2025, 3, 23, 0, 0, 0, 0), limit: 1, to: new Date(2025, 3, 24, 0, 0, 0, 0), }, type: "dora_deployments_list_request", }, }, }; apiInstance .listDORADeployments(params) .then((data: v2.DORADeploymentsListResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}