diff options
Diffstat (limited to 'doc/api/experiments.md')
-rw-r--r-- | doc/api/experiments.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/api/experiments.md b/doc/api/experiments.md new file mode 100644 index 00000000000..66c444e54ce --- /dev/null +++ b/doc/api/experiments.md @@ -0,0 +1,40 @@ +--- +stage: Growth +group: Expansion +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 +--- + +# Experiments API + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262725) in GitLab 13.5. + +This API is for listing Experiments [experiment use in development of GitLab](../development/experiment_guide/index.md). + +All methods require user be a [GitLab team member](https://gitlab.com/groups/gitlab-com/-/group_members) for authorization. + +## List all experiments + +Get a list of all experiments, with its enabled status. + +```plaintext +GET /experiments +``` + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/experiments" +``` + +Example response: + +```json +[ + { + "key": "experiment_1", + "enabled": true + }, + { + "key": "experiment_2", + "enabled": false + } +] +``` |