部署令牌 API

列出所有部署令牌#

获取整个极狐 GitLab 实例中的所有部署令牌的列表。此端点需要管理员访问权限。

plaintext
GET /deploy_tokens

参数：

请求示例：

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

响应示例：

json
1[
2  {
3    "id": 1,
4    "name": "MyToken",
5    "username": "gitlab+deploy-token-1",
6    "expires_at": "2020-02-14T00:00:00.000Z",
7    "revoked": false,
8    "expired": false,
9    "scopes": [
10      "read_repository",
11      "read_registry"
12    ]
13  }
14]

项目部署令牌#

项目部署令牌 API 端点至少需要项目的维护者角色。

列出项目部署令牌#

获取项目的部署令牌列表。

plaintext
GET /projects/:id/deploy_tokens

参数：

请求示例：

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

响应示例：

json
1[
2  {
3    "id": 1,
4    "name": "MyToken",
5    "username": "gitlab+deploy-token-1",
6    "expires_at": "2020-02-14T00:00:00.000Z",
7    "revoked": false,
8    "expired": false,
9    "scopes": [
10      "read_repository",
11      "read_registry"
12    ]
13  }
14]

获取项目部署令牌#

通过 ID 获取单个项目的部署令牌。

plaintext
GET /projects/:id/deploy_tokens/:token_id

参数：

请求示例：

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

响应示例：

json
1{
2  "id": 1,
3  "name": "MyToken",
4  "username": "gitlab+deploy-token-1",
5  "expires_at": "2020-02-14T00:00:00.000Z",
6  "revoked": false,
7  "expired": false,
8  "scopes": [
9    "read_repository",
10    "read_registry"
11  ]
12}

创建项目部署令牌#

为项目创建一个新的部署令牌。

plaintext
POST /projects/:id/deploy_tokens

参数：

请求示例：

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"]}' \
  --url "https://gitlab.example.com/api/v4/projects/5/deploy_tokens/"

响应示例：

json
1{
2  "id": 1,
3  "name": "My deploy token",
4  "username": "custom-user",
5  "expires_at": "2021-01-01T00:00:00.000Z",
6  "token": "jMRvtPNxrn3crTAGukpZ",
7  "revoked": false,
8  "expired": false,
9  "scopes": [
10    "read_repository"
11  ]
12}

删除项目部署令牌#

从项目中移除一个部署令牌。

plaintext
DELETE /projects/:id/deploy_tokens/:token_id

参数：

请求示例：

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

群组部署令牌#

拥有至少群组维护者角色的用户可以列出群组部署令牌。只有群组所有者可以创建和删除群组部署令牌。

列出群组部署令牌#

获取群组的部署令牌列表。

plaintext
GET /groups/:id/deploy_tokens

参数：

请求示例：

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

响应示例：

json
1[
2  {
3    "id": 1,
4    "name": "MyToken",
5    "username": "gitlab+deploy-token-1",
6    "expires_at": "2020-02-14T00:00:00.000Z",
7    "revoked": false,
8    "expired": false,
9    "scopes": [
10      "read_repository",
11      "read_registry"
12    ]
13  }
14]

获取群组部署令牌#

通过 ID 获取单个群组的部署令牌。

plaintext
GET /groups/:id/deploy_tokens/:token_id

参数：

请求示例：

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

响应示例：

json
1{
2  "id": 1,
3  "name": "MyToken",
4  "username": "gitlab+deploy-token-1",
5  "expires_at": "2020-02-14T00:00:00.000Z",
6  "revoked": false,
7  "expired": false,
8  "scopes": [
9    "read_repository",
10    "read_registry"
11  ]
12}

创建群组部署令牌#

为群组创建一个新的部署令牌。

plaintext
POST /groups/:id/deploy_tokens

参数：

请求示例：

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"]}' \
  --url "https://gitlab.example.com/api/v4/groups/5/deploy_tokens/"

响应示例：

json
1{
2  "id": 1,
3  "name": "My deploy token",
4  "username": "custom-user",
5  "expires_at": "2021-01-01T00:00:00.000Z",
6  "token": "jMRvtPNxrn3crTAGukpZ",
7  "revoked": false,
8  "expired": false,
9  "scopes": [
10    "read_registry"
11  ]
12}

删除群组部署令牌#

从群组中移除一个部署令牌。

plaintext
DELETE /groups/:id/deploy_tokens/:token_id

参数：

请求示例：

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