gitlab-org--gitlab-foss/doc/api/deploy_tokens.md

Deploy Tokens API

List all deploy tokens

Get a list of all deploy tokens across the GitLab instance. This endpoint requires admin access.

GET /deploy_tokens

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/deploy_tokens"

Example response:

[
  {
    "id": 1,
    "name": "MyToken",
    "username": "gitlab+deploy-token-1",
    "expires_at": "2020-02-14T00:00:00.000Z",
    "scopes": [
      "read_repository",
      "read_registry"
    ]
  }
]

Project deploy tokens

Project deploy token API endpoints require project maintainer access or higher.

List project deploy tokens

Get a list of a project's deploy tokens.

GET /projects/:id/deploy_tokens

Parameters:

Attribute	Type	Required	Description
id	integer/string	yes	ID or URL-encoded path of the project.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deploy_tokens"

Example response:

[
  {
    "id": 1,
    "name": "MyToken",
    "username": "gitlab+deploy-token-1",
    "expires_at": "2020-02-14T00:00:00.000Z",
    "scopes": [
      "read_repository",
      "read_registry"
    ]
  }
]

Group deploy tokens

These endpoints require group maintainer access or higher.

Delete a group deploy token

Removes a deploy token from the group.

DELETE /groups/:id/deploy_tokens/:token_id

Attribute	Type	Required	Description
id	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user
token_id	integer	yes	The ID of the deploy token

Example request:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/deploy_tokens/13"