---
title: "Get a list of deployment events"
method: POST
path: "/api/v2/dora/deployments"
tags: ["DORA Metrics"]
---

# Get a list of deployment events

`POST /api/v2/dora/deployments`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/dora/deployments`
- Auth: API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`

Use this API endpoint to get a list of deployment events.

## Request body

- DORAListDeploymentsRequest: Request to get a list of deployments.
  - `data` DORAListDeploymentsRequestData, required: The JSON:API data.
    - `attributes` DORAListDeploymentsRequestAttributes, required: Attributes to get a list of deployments.
      - `from` string, date-time: Minimum timestamp for requested events.
      - `limit` integer: Maximum number of events in the response.
      - `query` string: Search query with event platform syntax.
      - `sort` string: Sort order (prefixed with `-` for descending).
      - `to` string, date-time: Maximum timestamp for requested events.
    - `type` 'dora_deployments_list_request': The definition of `DORAListDeploymentsRequestDataType` object.

## Response `200`

OK

- DORADeploymentsListResponse: Response for the list deployments endpoint.
  - `data` DORADeploymentObject[]: The list of DORA deployment events.
    - `attributes` DORADeploymentObjectAttributes: The attributes of the deployment event.
      - `custom_tags` string[], nullable: A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.
      - `env` string: Environment name to where the service was deployed.
      - `finished_at` string, date-time: The time when the deployment finished.
      - `git` DORAGitInfoResponse: Git info returned by DORA Metrics events.
        - `commit_sha` string, required: Git Commit SHA.
        - `repository_id` string, required: Git Repository ID
      - `service` string, required: Service name.
      - `started_at` string, date-time, required: The time when the deployment started.
      - `team` string: Name of the team owning the deployed service.
      - `version` string: Version to correlate with APM Deployment Tracking.
    - `id` string: The ID of the deployment event.
    - `type` 'dora_deployment': JSON:API type for DORA deployment events.

## Other responses

- `400`: Bad Request
- `403`: Not Authorized
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)