OverviewInsights 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.

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

Path parameters

deploymentIDstringRequired
The deployment ID

Headers

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
opstringRequired
The type of operation to perform
pathstringRequired
A JSON Pointer string specifying the part of the document to operate on
valueanyOptional

Response

Deployment response
idstringformat: "uuid"
The deployment ID
applicationKeystring
The application key
applicationVersionstring
The application version
startedAtlong
The time the deployment started
statusstring
The status of the deployment
kindstring
The kind of deployment
activeboolean
Whether the deployment is active
archivedboolean
Whether the deployment is archived
environmentKeystring
The environment key
numberOfContributorsinteger
The number of contributors
numberOfPullRequestsinteger
The number of pull requests
linesAddedlong
The number of lines added
linesDeletedlong
The number of lines deleted
leadTimelong
The total lead time from first commit to deployment end in milliseconds
endedAtlong or null
The time the deployment ended
durationMslong or null
The duration of the deployment in milliseconds
metadatamap from strings to any or null
The metadata associated with the deployment
pullRequestsobject or null
The pull requests contained in the deployment
flagReferencesobject or null
The flag references contained in the deployment
leadTimeStagesobject or null
The lead time stages for the deployment

Errors