Update deployment

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

Update a deployment by ID. Uses a JSON patch or JSON merge patch representation of the desired changes.

The deployment ID is returned as part of the List deployments response. It is the id field of each element in the items array.

PATCH /api/v2/engineering-insights/deployments/{deploymentID}

Update deployment

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/status",
    "value": "finished"
  }
]
'

200

{
  "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": {
          "totalCount": 25,
          "items": "<array>",
          "_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"
            }
          }
        },
        "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
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

deploymentID · string<string> · required

The deployment ID

Body

application/json

op · string · required

The type of operation to perform

Example:

"replace"

path · string · required

A JSON Pointer string specifying the part of the document to operate on

Example:

"/exampleField"

value · any

A JSON value used in "add", "replace", and "test" operations

Example:

"new example value"

Response

200

application/json

Deployment response

id · string<uuid> · required

The deployment ID

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

applicationKey · string · required

The application key

Example:

"billing-service"

applicationVersion · string · required

The application version

Example:

"a90a8a2"

startedAt · integer<int64> · required

The time the deployment started

Example:

"1706701522000"

status · string · required

The status of the deployment

Example:

"finished"

kind · string · required

The kind of deployment

Example:

"redeployment"

active · boolean · required

Whether the deployment is active

Example:

true

archived · boolean · required

Whether the deployment is archived

Example:

false

environmentKey · string · required

The environment key

Example:

"production"

numberOfContributors · integer · required

The number of contributors

Example:

1

numberOfPullRequests · integer · required

The number of pull requests

Example:

2

linesAdded · integer<int64> · required

The number of lines added

Example:

100

linesDeleted · integer<int64> · required

The number of lines deleted

Example:

50

leadTime · integer<int64> · required

The total lead time from first commit to deployment end in milliseconds

Example:

20237000

endedAt · integer<int64>

The time the deployment ended

Example:

"1706712518000"

durationMs · integer<int64>

The duration of the deployment in milliseconds

Example:

10996000

metadata · object

The metadata associated with the deployment

Show child attributes

Example:

{ "buildNumber": "1234" }

pullRequests · object

The pull requests contained in the deployment

Show child attributes

flagReferences · object

The flag references contained in the deployment

Show child attributes

leadTimeStages · object

The lead time stages for the deployment

Show child attributes