Sign in
Insights deployments (beta)

Update deployment

Update a deployment by ID. Updating a deployment uses a JSON patch representation of the desired changes. To learn more, read Updates.<br/><br/>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}

Path parameters

deploymentIDstring string required

The deployment ID

The deployment ID

Request body

opstring required

The type of operation to perform

pathstring required

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

valuestring

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

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Deployment response

idstring uuid required

The deployment ID

applicationKeystring required

The application key

applicationVersionstring required

The application version

startedAtinteger required
endedAtinteger
durationMsinteger

The duration of the deployment in milliseconds

statusstring required
kindstring required
activeboolean required

Whether the deployment is active

metadataobject

The metadata associated with the deployment

archivedboolean required

Whether the deployment is archived

environmentKeystring required

The environment key

numberOfContributorsinteger required

The number of contributors

numberOfPullRequestsinteger required

The number of pull requests

linesAddedinteger required

The number of lines added

linesDeletedinteger required

The number of lines deleted

leadTimeinteger required

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

Example response

{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "applicationKey": "billing-service",
  "applicationVersion": "a90a8a2",
  "durationMs": 10996000,
  "active": true,
  "metadata": {
    "buildNumber": "1234"
  },
  "environmentKey": "production",
  "numberOfContributors": 1,
  "numberOfPullRequests": 2,
  "linesAdded": 100,
  "linesDeleted": 50,
  "leadTime": 20237000,
  "pullRequests": {
    "totalCount": 25,
    "items": [
      {
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "externalId": "1234",
        "title": "Enable new payment structure",
        "status": "merged",
        "author": "jane.doe",
        "mergeCommitKey": "a90a8a2",
        "baseCommitKey": "a90a8a2",
        "headCommitKey": "a90a8a2",
        "filesChanged": 2,
        "linesAdded": 100,
        "linesDeleted": 50,
        "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
        "deployments": {
          "totalCount": 25,
          "_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
  }
}

Changes