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 cluster_agents API

Operations related to the GitLab agent for Kubernetes

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

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

This API exposes 8 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 2.0, at version v4.

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

8 operations 4 paths 7 schemas 2 DELETE4 GET2 POST

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 cluster_agents 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 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

cluster_agents 8

Operations related to the GitLab agent for Kubernetes

GET
/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens
List tokens for an agent
getApiV4ProjectsIdClusterAgentsAgentIdTokens 4 params → 200
POST
/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens
Create an agent token
postApiV4ProjectsIdClusterAgentsAgentIdTokens 3 params → 201
GET
/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens/{token_id}
Get a single agent token
getApiV4ProjectsIdClusterAgentsAgentIdTokensTokenId 3 params → 200
DELETE
/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens/{token_id}
Revoke an agent token
deleteApiV4ProjectsIdClusterAgentsAgentIdTokensTokenId 3 params → 204
GET
/api/v4/projects/{id}/cluster_agents
List the agents for a project
getApiV4ProjectsIdClusterAgents 3 params → 200
POST
/api/v4/projects/{id}/cluster_agents
Register an agent with a project
postApiV4ProjectsIdClusterAgents 2 params → 201
GET
/api/v4/projects/{id}/cluster_agents/{agent_id}
Get details about an agent
getApiV4ProjectsIdClusterAgentsAgentId 2 params → 200
DELETE
/api/v4/projects/{id}/cluster_agents/{agent_id}
Delete a registered agent
deleteApiV4ProjectsIdClusterAgentsAgentId 2 params → 204

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are API_Entities_Clusters_AgentTokenWithToken (9 properties), API_Entities_Clusters_AgentToken (8 properties), API_Entities_ProjectIdentity (7 properties), API_Entities_Clusters_AgentTokenBasic (7 properties). Each schema is shown below with its type and property counts.

postApiV4ProjectsIdClusterAgents
object
Register an agent with a project
1 property 1 required
postApiV4ProjectsIdClusterAgentsAgentIdTokens
object
Create an agent token
2 properties 1 required
API_Entities_Clusters_Agent
object
APIEntitiesClustersAgent model
6 properties 6 required
API_Entities_Clusters_AgentToken
object
APIEntitiesClustersAgentToken model
8 properties 8 required
API_Entities_Clusters_AgentTokenBasic
object
APIEntitiesClustersAgentTokenBasic model
7 properties 7 required
API_Entities_ProjectIdentity
object
7 properties 7 required
API_Entities_Clusters_AgentTokenWithToken
object
APIEntitiesClustersAgentTokenWithToken model
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-cluster-agents-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 cluster_agents 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.