2020-07-15 00:09:23 +00:00
---
stage: Release
2020-12-01 15:09:28 +00:00
group: Release
2020-11-26 06:09:20 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-07-15 00:09:23 +00:00
---
2021-09-09 15:09:24 +00:00
# Deploy Tokens API **(FREE)**
2020-02-20 03:08:57 +00:00
2021-09-09 15:09:24 +00:00
## List all deploy tokens **(FREE SELF)**
2020-02-20 03:08:57 +00:00
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-11 06:10:11 +00:00
2021-09-23 22:34:10 +00:00
Get a list of all deploy tokens across the GitLab instance. This endpoint requires the Administrator role.
2020-02-20 03:08:57 +00:00
2020-02-28 12:09:05 +00:00
```plaintext
2020-02-20 03:08:57 +00:00
GET /deploy_tokens
```
2021-04-30 15:09:50 +00:00
Parameters:
| Attribute | Type | Required | Description |
|-----------|----------|------------------------|-------------|
| `active` | boolean | ** {dotted-circle}** No | Limit by active status. |
2020-02-28 12:09:05 +00:00
Example request:
2020-02-20 03:08:57 +00:00
```shell
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/deploy_tokens"
```
Example response:
```json
[
{
"id": 1,
"name": "MyToken",
"username": "gitlab+deploy-token-1",
"expires_at": "2020-02-14T00:00:00.000Z",
2021-04-30 15:09:50 +00:00
"revoked": false,
"expired": false,
2020-02-28 12:09:05 +00:00
"scopes": [
"read_repository",
"read_registry"
]
}
]
```
## Project deploy tokens
2021-05-31 18:09:56 +00:00
Project deploy token API endpoints require the [Maintainer role ](../user/permissions.md ) or higher
for the project.
2020-02-28 12:09:05 +00:00
### List project deploy tokens
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-11 06:10:11 +00:00
2020-02-28 12:09:05 +00:00
Get a list of a project's deploy tokens.
```plaintext
GET /projects/:id/deploy_tokens
```
Parameters:
2021-04-30 15:09:50 +00:00
| Attribute | Type | Required | Description |
|:---------------|:---------------|:-----------------------|:------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ). |
2021-04-30 15:09:50 +00:00
| `active` | boolean | ** {dotted-circle}** No | Limit by active status. |
2020-02-28 12:09:05 +00:00
Example request:
```shell
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/1/deploy_tokens"
```
Example response:
```json
[
{
"id": 1,
"name": "MyToken",
"username": "gitlab+deploy-token-1",
"expires_at": "2020-02-14T00:00:00.000Z",
2021-04-30 15:09:50 +00:00
"revoked": false,
"expired": false,
2020-02-20 03:08:57 +00:00
"scopes": [
"read_repository",
"read_registry"
]
}
]
```
2020-03-09 00:08:14 +00:00
2020-03-10 09:08:10 +00:00
### Create a project deploy token
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-10 09:08:10 +00:00
Creates a new deploy token for a project.
2020-03-25 06:07:58 +00:00
```plaintext
2020-03-10 09:08:10 +00:00
POST /projects/:id/deploy_tokens
```
2021-04-30 15:09:50 +00:00
Parameters:
| Attribute | Type | Required | Description |
| ------------ | ---------------- | ---------------------- | ----------- |
2021-06-28 15:08:03 +00:00
| `id` | integer/string | ** {check-circle}** Yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2021-04-30 15:09:50 +00:00
| `name` | string | ** {check-circle}** Yes | New deploy token's name |
| `expires_at` | datetime | ** {dotted-circle}** No | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) |
| `username` | string | ** {dotted-circle}** No | Username for deploy token. Default is `gitlab+deploy-token-{n}` |
| `scopes` | array of strings | ** {check-circle}** Yes | Indicates the deploy token scopes. Must be at least one of `read_repository` , `read_registry` , `write_registry` , `read_package_registry` , or `write_package_registry` . |
Example request:
2020-03-10 09:08:10 +00:00
```shell
2021-06-02 15:09:59 +00:00
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/projects/5/deploy_tokens/"
2020-03-10 09:08:10 +00:00
```
Example response:
```json
{
"id": 1,
"name": "My deploy token",
"username": "custom-user",
"expires_at": "2021-01-01T00:00:00.000Z",
"token": "jMRvtPNxrn3crTAGukpZ",
2021-04-30 15:09:50 +00:00
"revoked": false,
"expired": false,
2020-03-10 09:08:10 +00:00
"scopes": [
"read_repository"
]
}
```
2020-03-12 12:09:17 +00:00
### Delete a project deploy token
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-12 12:09:17 +00:00
Removes a deploy token from the project.
2020-03-25 06:07:58 +00:00
```plaintext
2020-03-12 12:09:17 +00:00
DELETE /projects/:id/deploy_tokens/:token_id
```
2021-04-30 15:09:50 +00:00
Parameters:
| Attribute | Type | Required | Description |
| ---------- | -------------- | ---------------------- | ----------- |
2021-06-28 15:08:03 +00:00
| `id` | integer/string | ** {check-circle}** Yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2021-04-30 15:09:50 +00:00
| `token_id` | integer | ** {check-circle}** Yes | The ID of the deploy token |
2020-03-12 12:09:17 +00:00
Example request:
```shell
2021-06-02 15:09:59 +00:00
curl --request DELETE --header "PRIVATE-TOKEN: < your_access_token > " \
"https://gitlab.example.com/api/v4/projects/5/deploy_tokens/13"
2020-03-12 12:09:17 +00:00
```
2020-03-09 00:08:14 +00:00
## Group deploy tokens
2020-07-01 21:08:51 +00:00
Group maintainers and owners can list group deploy
tokens. Only group owners can create and delete group deploy tokens.
2020-03-09 00:08:14 +00:00
2020-04-08 06:09:54 +00:00
### List group deploy tokens
2020-03-11 06:10:11 +00:00
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-11 06:10:11 +00:00
Get a list of a group's deploy tokens
2020-03-25 06:07:58 +00:00
```plaintext
2020-03-11 06:10:11 +00:00
GET /groups/:id/deploy_tokens
```
Parameters:
2021-04-30 15:09:50 +00:00
| Attribute | Type | Required | Description |
|:---------------|:---------------|:-----------------------|:------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | ** {check-circle}** Yes | ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ). |
2021-04-30 15:09:50 +00:00
| `active` | boolean | ** {dotted-circle}** No | Limit by active status. |
2020-03-11 06:10:11 +00:00
Example request:
```shell
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/groups/1/deploy_tokens"
```
Example response:
```json
[
{
"id": 1,
"name": "MyToken",
"username": "gitlab+deploy-token-1",
"expires_at": "2020-02-14T00:00:00.000Z",
2021-04-30 15:09:50 +00:00
"revoked": false,
"expired": false,
2020-03-11 06:10:11 +00:00
"scopes": [
"read_repository",
"read_registry"
]
}
]
```
2020-03-11 21:09:19 +00:00
### Create a group deploy token
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-11 21:09:19 +00:00
Creates a new deploy token for a group.
2020-03-25 06:07:58 +00:00
```plaintext
2020-03-11 21:09:19 +00:00
POST /groups/:id/deploy_tokens
```
2021-04-30 15:09:50 +00:00
Parameters:
| Attribute | Type | Required | Description |
| ------------ | ---- | --------- | ----------- |
2021-06-28 15:08:03 +00:00
| `id` | integer/string | ** {check-circle}** Yes | The ID or [URL-encoded path of the group ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2021-04-30 15:09:50 +00:00
| `name` | string | ** {check-circle}** Yes | New deploy token's name |
| `expires_at` | datetime | ** {dotted-circle}** No | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) |
| `username` | string | ** {dotted-circle}** No | Username for deploy token. Default is `gitlab+deploy-token-{n}` |
| `scopes` | array of strings | ** {check-circle}** Yes | Indicates the deploy token scopes. Must be at least one of `read_repository` , `read_registry` , `write_registry` , `read_package_registry` , or `write_package_registry` . |
2020-03-11 21:09:19 +00:00
Example request:
```shell
2021-06-02 15:09:59 +00:00
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/"
2020-03-11 21:09:19 +00:00
```
Example response:
```json
{
"id": 1,
"name": "My deploy token",
"username": "custom-user",
"expires_at": "2021-01-01T00:00:00.000Z",
"token": "jMRvtPNxrn3crTAGukpZ",
2021-04-30 15:09:50 +00:00
"revoked": false,
"expired": false,
2020-03-11 21:09:19 +00:00
"scopes": [
"read_registry"
]
}
```
2020-03-09 00:08:14 +00:00
### Delete a group deploy token
2020-05-21 06:08:25 +00:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
2020-03-11 06:10:11 +00:00
2020-03-09 00:08:14 +00:00
Removes a deploy token from the group.
2020-03-25 06:07:58 +00:00
```plaintext
2020-03-09 00:08:14 +00:00
DELETE /groups/:id/deploy_tokens/:token_id
```
2021-04-30 15:09:50 +00:00
Parameters:
| Attribute | Type | Required | Description |
| ----------- | -------------- | ---------------------- | ----------- |
2021-06-28 15:08:03 +00:00
| `id` | integer/string | ** {check-circle}** Yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
2021-04-30 15:09:50 +00:00
| `token_id` | integer | ** {check-circle}** Yes | The ID of the deploy token |
2020-03-09 00:08:14 +00:00
Example request:
```shell
curl --request DELETE --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/groups/5/deploy_tokens/13"
```