diff options
Diffstat (limited to 'doc/api/deployments.md')
| -rw-r--r-- | doc/api/deployments.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/api/deployments.md b/doc/api/deployments.md index 9618d57013f..daf2b635855 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -23,7 +23,7 @@ GET /projects/:id/deployments | `updated_after` | datetime | no | Return deployments updated after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | | `updated_before` | datetime | no | Return deployments updated before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | | `environment` | string | no | The [name of the environment](../ci/environments/index.md) to filter deployments by. | -| `status` | string | no | The status to filter deployments by. One of `created`, `running`, `success`, `failed`, `canceled`, `blocked`. +| `status` | string | no | The status to filter deployments by. One of `created`, `running`, `success`, `failed`, `canceled`, or `blocked`. ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deployments" @@ -133,7 +133,7 @@ Example response: "tag": false, "project": { "ci_job_token_scope_enabled": false - }, + }, "user": { "id": 1, "name": "Administrator", @@ -487,7 +487,11 @@ curl --request "DELETE" --header "PRIVATE-TOKEN: <your_access_token>" "https://g Example responses: ```json -{ "message": "202 Accepted" } +{ "message": "204 Deployment destroyed" } +``` + +```json +{ "message": "403 Forbidden" } ``` ```json @@ -503,8 +507,7 @@ Example responses: > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35739) in GitLab 12.7. NOTE: -Not all deployments can be associated with merge requests. -Please see +Not all deployments can be associated with merge requests. See [Track what merge requests were deployed to an environment](../ci/environments/index.md#track-newly-included-merge-requests-per-deployment) for more information. |