diff options
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 1a914fb1dbe..db0c593dc03 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,10 +1,10 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem 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/#assignments --- -# API Docs +# API Docs **(FREE)** Use the GitLab [REST](http://spec.openapis.org/oas/v3.0.3) API to automate GitLab. @@ -125,9 +125,10 @@ There are several ways you can authenticate with the GitLab API: - [Session cookie](#session-cookie) - [GitLab CI/CD job token](#gitlab-cicd-job-token) **(Specific endpoints only)** -NOTE: -Project access tokens are supported for self-managed instances on Free and -higher. They're also supported on GitLab.com Bronze and higher. +Project access tokens are supported by: + +- Self-managed GitLab Free and higher. +- GitLab SaaS Premium and higher. If you are an administrator, you or your application can authenticate as a specific user. To do so, use: @@ -208,6 +209,7 @@ You can use a GitLab CI/CD job token to authenticate with specific API endpoints Package Registry, you can use [deploy tokens](../user/project/deploy_tokens/index.md). - [Container Registry](../user/packages/container_registry/index.md) (the `$CI_REGISTRY_PASSWORD` is `$CI_JOB_TOKEN`). + - [Container Registry API](container_registry.md) (scoped to the job's project, when the `ci_job_token_scope` feature flag is enabled) - [Get job artifacts](job_artifacts.md#get-job-artifacts). - [Get job token's job](jobs.md#get-job-tokens-job). - [Pipeline triggers](pipeline_triggers.md), using the `token=` parameter. @@ -776,7 +778,3 @@ some API endpoints also support `text/plain`. In [GitLab 13.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/250342), API endpoints do not support `text/plain` by default, unless it's explicitly documented. - -This change is deployed behind the `:api_always_use_application_json` [feature flag](../user/feature_flags.md), -enabled by default. On GitLab self-managed instances, GitLab administrators can choose -to [disable it](../administration/feature_flags.md). **(FREE SELF)** |