debian-mirror-gitlab/doc/api/feature_flags.md

290 lines
11 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Release
group: Progressive Delivery
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---
2019-12-26 22:10:19 +05:30
# Feature Flags API **(PREMIUM)**
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5.
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
This API is behind a [feature flag](../operations/feature_flags.md#enable-or-disable-feature-flag-strategies).
If this flag is not enabled in your environment, you can use the [legacy feature flags API](feature_flags_legacy.md).
2019-12-26 22:10:19 +05:30
2020-07-28 23:09:34 +05:30
API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md).
2019-12-26 22:10:19 +05:30
Users with Developer or higher [permissions](../user/permissions.md) can access Feature Flag API.
## Feature Flags pagination
By default, `GET` requests return 20 results at a time because the API results
are [paginated](README.md#pagination).
## List feature flags for a project
Gets all feature flags of the requested project.
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-26 22:10:19 +05:30
GET /projects/:id/feature_flags
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `scope` | string | no | The condition of feature flags, one of: `enabled`, `disabled`. |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags"
2019-12-26 22:10:19 +05:30
```
Example response:
```json
[
{
"name":"merge_train",
"description":"This feature is about merge train",
2020-10-24 23:57:45 +05:30
"active": true,
2020-06-23 00:09:42 +05:30
"version": "new_version_flag",
2019-12-26 22:10:19 +05:30
"created_at":"2019-11-04T08:13:51.423Z",
"updated_at":"2019-11-04T08:13:51.423Z",
2020-06-23 00:09:42 +05:30
"scopes":[],
"strategies": [
{
"id": 1,
"name": "userWithId",
"parameters": {
"userIds": "user1"
},
"scopes": [
{
"id": 1,
"environment_scope": "production"
}
]
}
2019-12-26 22:10:19 +05:30
]
},
{
"name":"new_live_trace",
"description":"This is a new live trace feature",
2020-10-24 23:57:45 +05:30
"active": true,
2020-06-23 00:09:42 +05:30
"version": "new_version_flag",
2019-12-26 22:10:19 +05:30
"created_at":"2019-11-04T08:13:10.507Z",
"updated_at":"2019-11-04T08:13:10.507Z",
2020-06-23 00:09:42 +05:30
"scopes":[]
"strategies": [
{
"id": 2,
"name": "default",
"parameters": {},
"scopes": [
{
"id": 2,
"environment_scope": "staging"
}
]
}
2019-12-26 22:10:19 +05:30
]
}
]
```
2020-06-23 00:09:42 +05:30
## Get a single feature flag
Gets a single feature flag.
```plaintext
2020-10-24 23:57:45 +05:30
GET /projects/:id/feature_flags/:feature_flag_name
2020-06-23 00:09:42 +05:30
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2020-10-24 23:57:45 +05:30
| `feature_flag_name` | string | yes | The name of the feature flag. |
2020-06-23 00:09:42 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature
```
Example response:
```json
{
"name": "awesome_feature",
"description": null,
2020-10-24 23:57:45 +05:30
"active": true,
2020-06-23 00:09:42 +05:30
"version": "new_version_flag",
"created_at": "2020-05-13T19:56:33.119Z",
"updated_at": "2020-05-13T19:56:33.119Z",
"scopes": [],
"strategies": [
{
"id": 36,
"name": "default",
"parameters": {},
"scopes": [
{
"id": 37,
"environment_scope": "production"
}
]
}
]
}
```
## Create a feature flag
2019-12-26 22:10:19 +05:30
Creates a new feature flag.
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-26 22:10:19 +05:30
POST /projects/:id/feature_flags
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2020-06-23 00:09:42 +05:30
| `name` | string | yes | The name of the feature flag. |
| `version` | string | yes | The version of the feature flag. Must be `new_version_flag`. Omit or set to `legacy_flag` to create a [Legacy Feature Flag](feature_flags_legacy.md). |
| `description` | string | no | The description of the feature flag. |
2020-10-24 23:57:45 +05:30
| `active` | boolean | no | The active state of the flag. Defaults to true. [Supported](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/38350) in GitLab 13.3 and later. |
2020-07-28 23:09:34 +05:30
| `strategies` | JSON | no | The feature flag [strategies](../operations/feature_flags.md#feature-flag-strategies). |
2020-06-23 00:09:42 +05:30
| `strategies:name` | JSON | no | The strategy name. |
| `strategies:parameters` | JSON | no | The strategy parameters. |
| `strategies:scopes` | JSON | no | The scopes for the strategy. |
| `strategies:scopes:environment_scope` | string | no | The environment spec for the scope. |
2019-12-26 22:10:19 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl "https://gitlab.example.com/api/v4/projects/1/feature_flags" \
2019-12-26 22:10:19 +05:30
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \
--data @- << EOF
{
2020-06-23 00:09:42 +05:30
"name": "awesome_feature",
"version": "new_version_flag",
"strategies": [{ "name": "default", "parameters": {}, "scopes": [{ "environment_scope": "production" }] }]
2019-12-26 22:10:19 +05:30
}
EOF
```
Example response:
```json
{
2020-06-23 00:09:42 +05:30
"name": "awesome_feature",
"description": null,
2020-10-24 23:57:45 +05:30
"active": true,
2020-06-23 00:09:42 +05:30
"version": "new_version_flag",
"created_at": "2020-05-13T19:56:33.119Z",
"updated_at": "2020-05-13T19:56:33.119Z",
"scopes": [],
"strategies": [
{
"id": 36,
"name": "default",
"parameters": {},
"scopes": [
{
"id": 37,
"environment_scope": "production"
}
]
}
]
2019-12-26 22:10:19 +05:30
}
```
2020-06-23 00:09:42 +05:30
## Update a feature flag
2019-12-26 22:10:19 +05:30
2020-06-23 00:09:42 +05:30
Updates a feature flag.
2019-12-26 22:10:19 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2020-10-24 23:57:45 +05:30
PUT /projects/:id/feature_flags/:feature_flag_name
2019-12-26 22:10:19 +05:30
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2020-10-24 23:57:45 +05:30
| `feature_flag_name` | string | yes | The current name of the feature flag. |
2020-06-23 00:09:42 +05:30
| `description` | string | no | The description of the feature flag. |
2020-10-24 23:57:45 +05:30
| `active` | boolean | no | The active state of the flag. [Supported](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/38350) in GitLab 13.3 and later. |
| `name` | string | no | The new name of the feature flag. [Supported](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/38350) in GitLab 13.3 and later. |
2020-07-28 23:09:34 +05:30
| `strategies` | JSON | no | The feature flag [strategies](../operations/feature_flags.md#feature-flag-strategies). |
2020-11-24 15:15:51 +05:30
| `strategies:id` | JSON | no | The feature flag strategy ID. |
2020-06-23 00:09:42 +05:30
| `strategies:name` | JSON | no | The strategy name. |
| `strategies:parameters` | JSON | no | The strategy parameters. |
| `strategies:scopes` | JSON | no | The scopes for the strategy. |
2020-11-24 15:15:51 +05:30
| `strategies:scopes:id` | JSON | no | The scopes ID. |
2020-06-23 00:09:42 +05:30
| `strategies:scopes:environment_scope` | string | no | The environment spec for the scope. |
2019-12-26 22:10:19 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature" \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \
--data @- << EOF
{
"strategies": [{ "name": "gradualRolloutUserId", "parameters": { "groupId": "default", "percentage": "25" }, "scopes": [{ "environment_scope": "staging" }] }]
}
EOF
2019-12-26 22:10:19 +05:30
```
Example response:
```json
{
2020-06-23 00:09:42 +05:30
"name": "awesome_feature",
"description": null,
2020-10-24 23:57:45 +05:30
"active": true,
2020-06-23 00:09:42 +05:30
"version": "new_version_flag",
"created_at": "2020-05-13T20:10:32.891Z",
"updated_at": "2020-05-13T20:10:32.891Z",
"scopes": [],
"strategies": [
{
"id": 38,
"name": "gradualRolloutUserId",
"parameters": {
"groupId": "default",
"percentage": "25"
2019-12-26 22:10:19 +05:30
},
2020-06-23 00:09:42 +05:30
"scopes": [
{
"id": 40,
"environment_scope": "staging"
}
]
},
{
"id": 37,
"name": "default",
"parameters": {},
"scopes": [
{
"id": 39,
"environment_scope": "production"
}
]
}
]
2019-12-26 22:10:19 +05:30
}
```
2020-06-23 00:09:42 +05:30
## Delete a feature flag
2019-12-26 22:10:19 +05:30
Deletes a feature flag.
2020-04-08 14:13:33 +05:30
```plaintext
2020-10-24 23:57:45 +05:30
DELETE /projects/:id/feature_flags/:feature_flag_name
2019-12-26 22:10:19 +05:30
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
2020-10-24 23:57:45 +05:30
| `feature_flag_name` | string | yes | The name of the feature flag. |
2019-12-26 22:10:19 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature"
2019-12-26 22:10:19 +05:30
```