diff options
Diffstat (limited to 'doc/api/instance_level_ci_variables.md')
| -rw-r--r-- | doc/api/instance_level_ci_variables.md | 49 |
1 files changed, 23 insertions, 26 deletions
diff --git a/doc/api/instance_level_ci_variables.md b/doc/api/instance_level_ci_variables.md index 840744bcae1..2bf9b209e20 100644 --- a/doc/api/instance_level_ci_variables.md +++ b/doc/api/instance_level_ci_variables.md @@ -6,9 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Instance-level CI/CD variables API **(FREE SELF)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14108) in GitLab 13.0 -> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/218249) in GitLab 13.2. - ## List all instance variables Get the list of all instance-level variables. @@ -50,9 +47,9 @@ Get the details of a specific instance-level variable. GET /admin/ci/variables/:key ``` -| Attribute | Type | required | Description | -|-----------|---------|----------|-----------------------| -| `key` | string | yes | The `key` of a variable | +| Attribute | Type | Required | Description | +|-----------|---------|----------|-------------| +| `key` | string | Yes | The `key` of a variable | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/ci/variables/TEST_VARIABLE_1" @@ -73,20 +70,20 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a Create a new instance-level variable. -[In GitLab 13.1 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/216097), the maximum number of allowed instance-level variables can be changed. +The [maximum number of instance-level variables](../administration/instance_limits.md#number-of-instance-level-variables) can be changed. ```plaintext POST /admin/ci/variables ``` -| Attribute | Type | required | Description | -|-----------------|---------|----------|-----------------------| -| `key` | string | yes | The `key` of a variable. Max 255 characters, only `A-Z`, `a-z`, `0-9`, and `_` are allowed. | -| `value` | string | yes | The `value` of a variable. 10,000 characters allowed ([GitLab 13.3 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/220028)). | -| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file`. | -| `protected` | boolean | no | Whether the variable is protected. | -| `masked` | boolean | no | Whether the variable is masked. | -| `raw` | boolean | no | Whether the variable is expandable. | +| Attribute | Type | Required | Description | +|-----------------|---------|----------|-------------| +| `key` | string | Yes | The `key` of a variable. Maximum of 255 characters, only `A-Z`, `a-z`, `0-9`, and `_` are allowed. | +| `value` | string | Yes | The `value` of a variable. Maximum of 10,000 characters. | +| `variable_type` | string | No | The type of a variable. Available types are: `env_var` (default) and `file`. | +| `protected` | boolean | No | Whether the variable is protected. | +| `masked` | boolean | No | Whether the variable is masked. | +| `raw` | boolean | No | Whether the variable is expandable. | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ @@ -112,14 +109,14 @@ Update an instance-level variable. PUT /admin/ci/variables/:key ``` -| Attribute | Type | required | Description | -|-----------------|---------|----------|-------------------------| -| `key` | string | yes | The `key` of a variable. | -| `value` | string | yes | The `value` of a variable. 10,000 characters allowed ([GitLab 13.3 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/220028)). | -| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file`. | -| `protected` | boolean | no | Whether the variable is protected. | -| `masked` | boolean | no | Whether the variable is masked. | -| `raw` | boolean | no | Whether the variable is expandable. | +| Attribute | Type | Required | Description | +|-----------------|---------|----------|-------------| +| `key` | string | Yes | The `key` of a variable. Maximum of 255 characters, only `A-Z`, `a-z`, `0-9`, and `_` are allowed. | +| `value` | string | Yes | The `value` of a variable. Maximum of 10,000 characters. | +| `variable_type` | string | No | The type of a variable. Available types are: `env_var` (default) and `file`. | +| `protected` | boolean | No | Whether the variable is protected. | +| `masked` | boolean | No | Whether the variable is masked. | +| `raw` | boolean | No | Whether the variable is expandable. | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \ @@ -145,9 +142,9 @@ Remove an instance-level variable. DELETE /admin/ci/variables/:key ``` -| Attribute | Type | required | Description | -|-----------|---------|----------|-------------------------| -| `key` | string | yes | The `key` of a variable | +| Attribute | Type | Required | Description | +|-----------|--------|----------|-------------| +| `key` | string | Yes | The `key` of a variable | ```shell curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/ci/variables/VARIABLE_1" |