For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
      • POSTCreate deployment event
      • GETGet deployment
      • GETList deployments
      • PATCHUpdate deployment
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewInsights Deployments Beta

List deployments

GET
/api/v2/engineering-insights/deployments
GET
/api/v2/engineering-insights/deployments
$curl -G https://app.launchdarkly.com/api/v2/engineering-insights/deployments \
>     -H "Authorization: <apiKey>" \
>     -d projectKey=projectKey \
>     -d environmentKey=environmentKey
1{
2  "totalCount": 25,
3  "items": [
4    {
5      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
6      "applicationKey": "billing-service",
7      "applicationVersion": "a90a8a2",
8      "startedAt": 1706701522000,
9      "status": "finished",
10      "kind": "redeployment",
11      "active": true,
12      "archived": false,
13      "environmentKey": "production",
14      "numberOfContributors": 1,
15      "numberOfPullRequests": 2,
16      "linesAdded": 100,
17      "linesDeleted": 50,
18      "leadTime": 20237000,
19      "endedAt": 1706712518000,
20      "durationMs": 10996000,
21      "metadata": {
22        "buildNumber": "1234"
23      },
24      "pullRequests": {
25        "totalCount": 25,
26        "items": [
27          {
28            "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
29            "externalId": "1234",
30            "title": "Enable new payment structure",
31            "status": "merged",
32            "author": "jane.doe",
33            "createTime": 1706701522000,
34            "baseCommitKey": "a90a8a2",
35            "headCommitKey": "a90a8a2",
36            "filesChanged": 2,
37            "linesAdded": 100,
38            "linesDeleted": 50,
39            "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
40            "mergeTime": 1706712518000,
41            "mergeCommitKey": "a90a8a2",
42            "deployments": {
43              "totalCount": 25,
44              "items": [
45                null
46              ],
47              "_links": {
48                "next": {
49                  "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
50                  "type": "application/json"
51                },
52                "self": {
53                  "href": "/api/v2/engineering-insights/deployments",
54                  "type": "application/json"
55                }
56              }
57            },
58            "flagReferences": {
59              "totalCount": 25,
60              "items": [
61                {
62                  "projectKey": "default",
63                  "flagKey": "enable-new-payment-structure",
64                  "referencesAdded": 2,
65                  "referencesRemoved": 5
66                }
67              ]
68            },
69            "leadTime": {
70              "codingDurationMs": 1000000,
71              "reviewDurationMs": 500000,
72              "maxWaitDurationMs": 100000,
73              "avgWaitDurationMs": 100000,
74              "maxDeployDurationMs": 100000,
75              "avgDeployDurationMs": 100000,
76              "maxTotalLeadTimeMs": 1600000,
77              "avgTotalLeadTimeMs": 1600000
78            }
79          }
80        ],
81        "_links": {
82          "next": {
83            "href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
84            "type": "application/json"
85          },
86          "self": {
87            "href": "/api/v2/engineering-insights/pull-requests",
88            "type": "application/json"
89          }
90        }
91      },
92      "flagReferences": {
93        "totalCount": 25,
94        "items": [
95          {
96            "projectKey": "default",
97            "flagKey": "enable-new-payment-structure",
98            "referencesAdded": 2,
99            "referencesRemoved": 5
100          }
101        ]
102      },
103      "leadTimeStages": {
104        "codingDurationMs": 1000000,
105        "reviewDurationMs": 500000,
106        "waitDurationMs": 100000,
107        "deployDurationMs": 100000,
108        "totalLeadTimeMs": 1600000
109      }
110    }
111  ],
112  "_links": {
113    "next": {
114      "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
115      "type": "application/json"
116    },
117    "self": {
118      "href": "/api/v2/engineering-insights/deployments",
119      "type": "application/json"
120    }
121  }
122}
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.
Was this page helpful?
Previous

Update deployment

Next
Built with

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.

Authentication

Authorizationstring
API Key authentication via header

Query parameters

projectKeystringRequiredformat: "string"
The project key
environmentKeystringRequiredformat: "string"
The environment key
applicationKeystringOptionalformat: "string"
Comma separated list of application keys
limitlongOptional
The number of deployments to return. Default is 20. Maximum allowed is 100.
expandstringOptionalformat: "string"

Expand properties in response. Options: pullRequests, flagReferences

fromlongOptional
Unix timestamp in milliseconds. Default value is 7 days ago.
tolongOptional
Unix timestamp in milliseconds. Default value is now.
afterstringOptionalformat: "string"
Identifier used for pagination
beforestringOptionalformat: "string"
Identifier used for pagination
kindstringOptionalformat: "string"
The deployment kind
statusstringOptionalformat: "string"
The deployment status

Response

Deployment collection response
totalCountinteger
The total number of deployments
itemslist of objects
A list of deployments
_linksmap from strings to objects
The location and content type of related resources

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error