diff options
Diffstat (limited to 'doc/api/group_level_variables.md')
| -rw-r--r-- | doc/api/group_level_variables.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md index aeab76b7212..68474a2aec7 100644 --- a/doc/api/group_level_variables.md +++ b/doc/api/group_level_variables.md @@ -91,15 +91,15 @@ POST /groups/:id/variables | Attribute | Type | Required | Description | |---------------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | -| `key` | string | Yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed | -| `value` | string | Yes | The `value` of a variable | -| `description` | string | No | The `description` of the variable. Default: `null` | -| `environment_scope` **(PREMIUM ALL)** | string | No | The [environment scope](../ci/environments/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable | -| `masked` | boolean | No | Whether the variable is masked | -| `protected` | boolean | No | Whether the variable is protected | +| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `key` | string | Yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed. | +| `value` | string | Yes | The `value` of a variable. | +| `description` | string | No | The `description` of the variable. Default: `null`. | +| `environment_scope` | string | No | The [environment scope](../ci/environments/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable. Premium and Ultimate only. | +| `masked` | boolean | No | Whether the variable is masked. | +| `protected` | boolean | No | Whether the variable is protected. | | `raw` | boolean | No | Whether the variable is treated as a raw string. Default: `false`. When `true`, variables in the value are not [expanded](../ci/variables/index.md#prevent-cicd-variable-expansion). | -| `variable_type` | string | No | The type of a variable. Available types are: `env_var` (default) and `file` | +| `variable_type` | string | No | The type of a variable. Available types are: `env_var` (default) and `file`. | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ @@ -136,7 +136,7 @@ PUT /groups/:id/variables/:key | `key` | string | Yes | The `key` of a variable | | `value` | string | Yes | The `value` of a variable | | `description` | string | No | The description of the variable. Default: `null`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409641) in GitLab 16.2. | -| `environment_scope` **(PREMIUM ALL)** | string | No | The [environment scope](../ci/environments/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable | +| `environment_scope` | string | No | The [environment scope](../ci/environments/index.md#limit-the-environment-scope-of-a-cicd-variable) of a variable. Premium and Ultimate only. | | `filter` | hash | No | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | | `masked` | boolean | No | Whether the variable is masked | | `protected` | boolean | No | Whether the variable is protected | |