diff options
Diffstat (limited to 'doc/api/deploy_tokens.md')
| -rw-r--r-- | doc/api/deploy_tokens.md | 84 |
1 files changed, 56 insertions, 28 deletions
diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index eae46d5f2f5..ad144946445 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -16,6 +16,12 @@ Get a list of all deploy tokens across the GitLab instance. This endpoint requir GET /deploy_tokens ``` +Parameters: + +| Attribute | Type | Required | Description | +|-----------|----------|------------------------|-------------| +| `active` | boolean | **{dotted-circle}** No | Limit by active status. | + Example request: ```shell @@ -31,6 +37,8 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", + "revoked": false, + "expired": false, "scopes": [ "read_repository", "read_registry" @@ -55,9 +63,10 @@ GET /projects/:id/deploy_tokens Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| Attribute | Type | Required | Description | +|:---------------|:---------------|:-----------------------|:------------| +| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `active` | boolean | **{dotted-circle}** No | Limit by active status. | Example request: @@ -74,6 +83,8 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", + "revoked": false, + "expired": false, "scopes": [ "read_repository", "read_registry" @@ -92,13 +103,17 @@ Creates a new deploy token for a project. POST /projects/:id/deploy_tokens ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](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. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `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`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | +Parameters: + +| Attribute | Type | Required | Description | +| ------------ | ---------------- | ---------------------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `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: ```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/projects/5/deploy_tokens/" @@ -113,6 +128,8 @@ Example response: "username": "custom-user", "expires_at": "2021-01-01T00:00:00.000Z", "token": "jMRvtPNxrn3crTAGukpZ", + "revoked": false, + "expired": false, "scopes": [ "read_repository" ] @@ -129,10 +146,12 @@ Removes a deploy token from the project. DELETE /projects/:id/deploy_tokens/:token_id ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `token_id` | integer | yes | The ID of the deploy token | +Parameters: + +| Attribute | Type | Required | Description | +| ---------- | -------------- | ---------------------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `token_id` | integer | **{check-circle}** Yes | The ID of the deploy token | Example request: @@ -157,9 +176,10 @@ GET /groups/:id/deploy_tokens Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| Attribute | Type | Required | Description | +|:---------------|:---------------|:-----------------------|:------------| +| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `active` | boolean | **{dotted-circle}** No | Limit by active status. | Example request: @@ -176,6 +196,8 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", + "revoked": false, + "expired": false, "scopes": [ "read_repository", "read_registry" @@ -194,13 +216,15 @@ 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. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `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`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | +Parameters: + +| Attribute | Type | Required | Description | +| ------------ | ---- | --------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `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: @@ -217,6 +241,8 @@ Example response: "username": "custom-user", "expires_at": "2021-01-01T00:00:00.000Z", "token": "jMRvtPNxrn3crTAGukpZ", + "revoked": false, + "expired": false, "scopes": [ "read_registry" ] @@ -233,10 +259,12 @@ 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](README.md#namespaced-path-encoding) owned by the authenticated user | -| `token_id` | integer | yes | The ID of the deploy token | +Parameters: + +| Attribute | Type | Required | Description | +| ----------- | -------------- | ---------------------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `token_id` | integer | **{check-circle}** Yes | The ID of the deploy token | Example request: |