How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitLab CI/CD clusters API

Operations related to clusters

GitLab CI/CD clusters API is one of 98 APIs that GitLab CI/CD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 16 operations across 10 paths, and defines 19 schemas. It is described by OpenAPI 2.0, at version v4.

Requests are made against the base URL https://gitlab.com/api/v4.

16 operations 10 paths 19 schemas 3 DELETE7 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v4
Base URL
https://gitlab.com/api/v4
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

GitLab CI/CD clusters API declares 2 security schemes for authenticating requests. An API key is passed in the header as PRIVATE-TOKEN (access_token_header). An API key is passed in the query as private_token (access_token_query).

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 3 DELETE, 7 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

clusters 16

Operations related to clusters

GET
/api/v4/groups/{id}/clusters
List group clusters
getApiV4GroupsIdClusters 3 params → 200403
GET
/api/v4/groups/{id}/clusters/{cluster_id}
Get a single group cluster
getApiV4GroupsIdClustersClusterId 2 params → 200403404
PUT
/api/v4/groups/{id}/clusters/{cluster_id}
Edit group cluster
putApiV4GroupsIdClustersClusterId 3 params → 200400403404
DELETE
/api/v4/groups/{id}/clusters/{cluster_id}
Delete group cluster
deleteApiV4GroupsIdClustersClusterId 2 params → 403204404
POST
/api/v4/groups/{id}/clusters/user
Add existing cluster to group
postApiV4GroupsIdClustersUser 2 params → 201400403404
GET
/api/v4/projects/{id}/clusters
List project clusters
getApiV4ProjectsIdClusters 3 params → 200403
GET
/api/v4/projects/{id}/clusters/{cluster_id}
Get a single project cluster
getApiV4ProjectsIdClustersClusterId 2 params → 200403404
PUT
/api/v4/projects/{id}/clusters/{cluster_id}
Edit project cluster
putApiV4ProjectsIdClustersClusterId 3 params → 200400403404
DELETE
/api/v4/projects/{id}/clusters/{cluster_id}
Delete project cluster
deleteApiV4ProjectsIdClustersClusterId 2 params → 403204404
POST
/api/v4/projects/{id}/clusters/user
Add existing cluster to project
postApiV4ProjectsIdClustersUser 2 params → 201400403404
GET
/api/v4/admin/clusters
List instance clusters
getApiV4AdminClusters → 200403
GET
/api/v4/admin/clusters/{cluster_id}
Get a single instance cluster
getApiV4AdminClustersClusterId 1 param → 200403404
PUT
/api/v4/admin/clusters/{cluster_id}
Edit instance cluster
putApiV4AdminClustersClusterId 2 params → 200400403404
DELETE
/api/v4/admin/clusters/{cluster_id}
Delete instance cluster
deleteApiV4AdminClustersClusterId 1 param → 403204404
POST
/api/v4/admin/clusters/add
Add existing instance cluster
postApiV4AdminClustersAdd 1 param → 201400403404
GET
/api/v4/discover-cert-based-clusters
Discover all descendant certificate-based clusters in a group
getApiV4DiscoverCertBasedClusters 1 param → 200403

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are API_Entities_BasicProjectDetails (24 properties), API_Entities_ClusterProject (16 properties), API_Entities_ClusterGroup (16 properties), API_Entities_Cluster (15 properties). Each schema is shown below with its type and property counts.

API_Entities_Cluster
object
APIEntitiesCluster model
15 properties 15 required
API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
putApiV4AdminClustersClusterId
object
Edit instance cluster
8 properties
API_Entities_ClusterGroup
object
APIEntitiesClusterGroup model
16 properties 16 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
API_Entities_ProjectIdentity
object
7 properties 7 required
postApiV4AdminClustersAdd
object
Add existing instance cluster
8 properties 2 required
API_Entities_Platform_Kubernetes
object
4 properties 4 required
API_Entities_NamespaceBasic
object
8 properties 8 required
putApiV4GroupsIdClustersClusterId
object
Edit group cluster
8 properties
API_Entities_BasicProjectDetails
object
APIEntitiesBasicProjectDetails model
24 properties 17 required
API_Entities_Provider_Gcp
object
7 properties 7 required
API_Entities_ClusterProject
object
APIEntitiesClusterProject model
16 properties 16 required
postApiV4GroupsIdClustersUser
object
Add existing cluster to group
8 properties 2 required
putApiV4ProjectsIdClustersClusterId
object
Edit project cluster
8 properties
API_Entities_DiscoveredClusters
object
APIEntitiesDiscoveredClusters model
2 properties 2 required
API_Entities_BasicGroupDetails
object
APIEntitiesBasicGroupDetails model
3 properties 3 required
postApiV4ProjectsIdClustersUser
object
Add existing cluster to project
8 properties 2 required
API_Entities_LicenseBasic
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-clusters-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
GitLab CI/CD access_requests API
GitLab CI/CD access_tokens API
GitLab CI/CD agents API
GitLab CI/CD alert_management API
GitLab CI/CD applications API
GitLab CI/CD attestations API
GitLab CI/CD audit_events API
GitLab CI/CD avatars API
GitLab CI/CD award_emoji API
GitLab CI/CD badges API
GitLab CI/CD batched_background_migrations API
Where this information came from

This is an independent, third-party profile of GitLab CI/CD clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.