summaryrefslogtreecommitdiff
path: root/doc/api/deploy_tokens.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-11 21:09:19 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-11 21:09:19 +0000
commitfca89bb73ff5b1d14c98c72481f9268fee107ea0 (patch)
treee1c8a2c4fe5df7f054fd09e49f53bcfb51e51c84 /doc/api/deploy_tokens.md
parent76e9fc7b29c1ce716c26932e9fbec0f3c99f53f4 (diff)
downloadgitlab-ce-fca89bb73ff5b1d14c98c72481f9268fee107ea0.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/deploy_tokens.md')
-rw-r--r--doc/api/deploy_tokens.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md
index c5c88619aa6..49bfed3e431 100644
--- a/doc/api/deploy_tokens.md
+++ b/doc/api/deploy_tokens.md
@@ -156,6 +156,45 @@ Example response:
]
```
+### Create a group deploy token
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/21811) in GitLab 12.9.
+
+Creates a new deploy token for a group.
+
+```
+POST /groups/:id/deploy_tokens
+```
+
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
+| `name` | string | yes | New deploy token's name |
+| `expires_at` | datetime | no | Expiration date for the deploy token. Does not expire if no value is provided. |
+| `username` | string | no | Username for deploy token. Default is `gitlab+deploy-token-{n}` |
+| `scopes` | array of strings | yes | Indicates the deploy token scopes. Must be at least one of `read_repository` or `read_registry`. |
+
+Example request:
+
+```shell
+curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"name": "My deploy token", "expires_at": "2021-01-01", "username": "custom-user", "scopes": ["read_repository"]}' "https://gitlab.example.com/api/v4/groups/5/deploy_tokens/"
+```
+
+Example response:
+
+```json
+{
+ "id": 1,
+ "name": "My deploy token",
+ "username": "custom-user",
+ "expires_at": "2021-01-01T00:00:00.000Z",
+ "token": "jMRvtPNxrn3crTAGukpZ",
+ "scopes": [
+ "read_registry"
+ ]
+}
+```
+
### Delete a group deploy token
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/21811) in GitLab 12.9.