summaryrefslogtreecommitdiff
path: root/doc/api/deployments.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/deployments.md')
-rw-r--r--doc/api/deployments.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/api/deployments.md b/doc/api/deployments.md
index 6831f86e4ea..01fa4e11884 100644
--- a/doc/api/deployments.md
+++ b/doc/api/deployments.md
@@ -458,6 +458,37 @@ Deployments created by users on GitLab Premium or higher include the `approvals`
}
```
+## Delete a specific deployment
+
+Delete a specific deployment that is not currently the last deployment for an environment or in a `running` state
+
+```plaintext
+DELETE /projects/:id/deployments/:deployment_id
+```
+
+| Attribute | Type | Required | Description |
+|-----------|---------|----------|---------------------|
+| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
+| `deployment_id` | integer | yes | The ID of the deployment |
+
+```shell
+curl --request "DELETE" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deployments/1"
+```
+
+Example responses:
+
+```json
+{ "message": "202 Accepted" }
+```
+
+```json
+{ "message": "400 Cannot destroy running deployment" }
+```
+
+```json
+{ "message": "400 Deployment currently deployed to environment" }
+```
+
## List of merge requests associated with a deployment
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35739) in GitLab 12.7.