List deployments

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Get a list of deployments

Expanding the deployment collection response

LaunchDarkly supports expanding the deployment collection response to include additional fields.

To expand the response, append the expand query parameter and include the following:

• pullRequests includes details on all of the pull requests associated with each deployment
• flagReferences includes details on all of the references to flags in each deployment

For example, use ?expand=pullRequests to include the pullRequests field in the response. By default, this field is not included in the response.

GET /api/v2/engineering-insights/deployments

List deployments

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/deployments \
  --header 'Authorization: <api-key>'

200

{
  "totalCount": 25,
  "items": [
    {
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "applicationKey": "billing-service",
      "applicationVersion": "a90a8a2",
      "startedAt": "1706701522000",
      "status": "finished",
      "kind": "redeployment",
      "active": true,
      "archived": false,
      "environmentKey": "production",
      "numberOfContributors": 1,
      "numberOfPullRequests": 2,
      "linesAdded": 100,
      "linesDeleted": 50,
      "leadTime": 20237000,
      "endedAt": "1706712518000",
      "durationMs": 10996000,
      "metadata": {
        "buildNumber": "1234"
      },
      "pullRequests": {
        "totalCount": 25,
        "items": [
          {
            "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
            "externalId": "1234",
            "title": "Enable new payment structure",
            "status": "merged",
            "author": "jane.doe",
            "createTime": "1706701522000",
            "baseCommitKey": "a90a8a2",
            "headCommitKey": "a90a8a2",
            "filesChanged": 2,
            "linesAdded": 100,
            "linesDeleted": 50,
            "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
            "mergeTime": "1706712518000",
            "mergeCommitKey": "a90a8a2",
            "deployments": "<unknown>",
            "flagReferences": {
              "totalCount": 25,
              "items": [
                {
                  "projectKey": "default",
                  "flagKey": "enable-new-payment-structure",
                  "referencesAdded": 2,
                  "referencesRemoved": 5
                }
              ]
            },
            "leadTime": {
              "codingDurationMs": 1000000,
              "reviewDurationMs": 500000,
              "maxWaitDurationMs": 100000,
              "avgWaitDurationMs": 100000,
              "maxDeployDurationMs": 100000,
              "avgDeployDurationMs": 100000,
              "maxTotalLeadTimeMs": 1600000,
              "avgTotalLeadTimeMs": 1600000
            }
          }
        ],
        "_links": {
          "next": {
            "href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/engineering-insights/pull-requests",
            "type": "application/json"
          }
        }
      },
      "flagReferences": {
        "totalCount": 25,
        "items": [
          {
            "projectKey": "default",
            "flagKey": "enable-new-payment-structure",
            "referencesAdded": 2,
            "referencesRemoved": 5
          }
        ]
      },
      "leadTimeStages": {
        "codingDurationMs": 1000000,
        "reviewDurationMs": 500000,
        "waitDurationMs": 100000,
        "deployDurationMs": 100000,
        "totalLeadTimeMs": 1600000
      }
    }
  ],
  "_links": {
    "next": {
      "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/engineering-insights/deployments",
      "type": "application/json"
    }
  }
}

Authorizations

Authorization · string · header · required

Query Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

applicationKey · string<string>

Comma separated list of application keys

limit · integer<int64>

The number of deployments to return. Default is 20. Maximum allowed is 100.

expand · string<string>

Expand properties in response. Options: pullRequests, flagReferences

from · integer<int64>

Unix timestamp in milliseconds. Default value is 7 days ago.

to · integer<int64>

Unix timestamp in milliseconds. Default value is now.

after · string<string>

Identifier used for pagination

before · string<string>

Identifier used for pagination

kind · string<string>

The deployment kind

status · string<string>

The deployment status

Response

200

application/json

Deployment collection response

totalCount · integer · required

The total number of deployments

Example:

25

items · object[] · required

A list of deployments

Show child attributes

_links · object

The location and content type of related resources

Show child attributes

Example:

{
  "next": {
    "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/engineering-insights/deployments",
    "type": "application/json"
  }
}