GitLab

GitLab Clusters API

> [!warning] > These certificate-based cluster endpoints are [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/work_items/8). Use this API to manage and discover the certificate-based Kubernetes clusters of an [instance](https://docs.gitlab.com/user/instance/clusters/), a [group](https://docs.gitlab.com/user/group/clusters/), or a [project](https://docs.gitlab.com/user/project/clusters/). Connecting a cluster to a group or an instance lets you use the same cluster across multiple projects. Instance endpoints require administrator access. Group and project endpoints require the Maintainer or Owner role.

Documentation GitHub OpenAPI

Operations 16

GET /api/v4/projects/{id}/clusters List all clusters in a project #

GET /api/v4/projects/{id}/clusters/{cluster_id} Retrieve a cluster from a project #

PUT /api/v4/projects/{id}/clusters/{cluster_id} Update a cluster in a project #

DELETE /api/v4/projects/{id}/clusters/{cluster_id} Delete cluster from a project #

POST /api/v4/projects/{id}/clusters/user Add a cluster to a project #

GET /api/v4/groups/{id}/clusters List all group clusters #

GET /api/v4/groups/{id}/clusters/{cluster_id} Retrieve a group cluster #

PUT /api/v4/groups/{id}/clusters/{cluster_id} Update a group cluster #

DELETE /api/v4/groups/{id}/clusters/{cluster_id} Delete a group cluster #

POST /api/v4/groups/{id}/clusters/user Create a group cluster #

GET /api/v4/discover-cert-based-clusters List all certificate-based clusters #

GET /api/v4/admin/clusters List all instance clusters #

GET /api/v4/admin/clusters/{cluster_id} Retrieve a single instance cluster #

PUT /api/v4/admin/clusters/{cluster_id} Update an instance cluster #

DELETE /api/v4/admin/clusters/{cluster_id} Delete instance cluster #

POST /api/v4/admin/clusters/add Create an instance cluster #

Documentation

https://docs.gitlab.com/api/openapi/

https://docs.gitlab.com/api/issues/

https://docs.gitlab.com/api/rest/authentication/

https://docs.gitlab.com/api/merge_requests/

https://docs.gitlab.com/api/pipelines/

https://docs.gitlab.com/api/jobs/

https://docs.gitlab.com/api/runners/

https://docs.gitlab.com/api/users/

https://docs.gitlab.com/api/repositories/

https://docs.gitlab.com/api/commits/

https://docs.gitlab.com/api/branches/

https://docs.gitlab.com/api/tags/

https://docs.gitlab.com/api/releases/

https://docs.gitlab.com/api/environments/

https://docs.gitlab.com/api/deployments/

https://docs.gitlab.com/api/pipeline_schedules/

https://docs.gitlab.com/api/labels/

https://docs.gitlab.com/api/milestones/

https://docs.gitlab.com/api/notes/

https://docs.gitlab.com/api/snippets/

https://docs.gitlab.com/api/packages/

https://docs.gitlab.com/api/container_registry/

https://docs.gitlab.com/api/vulnerabilities/

https://docs.gitlab.com/api/deploy_keys/

https://docs.gitlab.com/api/protected_branches/

https://docs.gitlab.com/api/wikis/

https://docs.gitlab.com/api/events/

https://docs.gitlab.com/api/search/

https://docs.gitlab.com/api/namespaces/

https://docs.gitlab.com/api/groups/

https://docs.gitlab.com/api/projects/

https://docs.gitlab.com/api/applications/

https://docs.gitlab.com/api/avatar/

https://docs.gitlab.com/api/broadcast_messages/

https://docs.gitlab.com/api/bulk_imports/

https://docs.gitlab.com/api/settings/

https://docs.gitlab.com/api/metadata/

https://docs.gitlab.com/api/version/

https://docs.gitlab.com/api/rest/

https://docs.gitlab.com/api/api_resources/

https://docs.gitlab.com/security/rate_limits/

https://docs.gitlab.com/api/oauth2/

https://docs.gitlab.com/integration/oauth_provider/

https://docs.gitlab.com/user/project/integrations/webhooks.html

https://docs.gitlab.com/api/project_webhooks/

Specifications

https://artifacts.apis.io/gitlab/openapi/gitlab-clusters-api-openapi.yml

https://artifacts.apis.io/gitlab/asyncapi/gitlab-webhooks-asyncapi.yml

Schemas & Data

https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-application-settings-request-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-node-status-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-site-status-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-application-setting-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-post-api-v4-geo-status-request-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-projects-id-request-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-cluster-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-batched-background-migration-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-ci-variable-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-dictionary-table-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-plan-limit-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-appearance-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-avatar-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-imports-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-import-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-metadata-schema.json

Other Resources

https://docs.gitlab.com/api/rest/third_party_clients/

Interactive Documentation

https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/gitlab:gitlab-clusters-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: GitLab REST Clusters API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/gitlab/openapi/gitlab-clusters-api-openapi.yml