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

Operations about runners

GitLab CI/CD runners 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 Runners. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 17 operations across 14 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.

17 operations 14 paths 19 schemas 2 DELETE8 GET6 POST1 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 runners 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 17

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

runners 17

Operations about runners

GET
/api/v4/groups/{id}/runners
List group's runners
getApiV4GroupsIdRunners 8 params → 200400403
POST
/api/v4/groups/{id}/runners/reset_registration_token
Reset the runner registration token for a group
postApiV4GroupsIdRunnersResetRegistrationToken 1 param → 201401403404
GET
/api/v4/projects/{id}/runners
List project's runners
getApiV4ProjectsIdRunners 9 params → 200400403
POST
/api/v4/projects/{id}/runners
Assign a runner to project
postApiV4ProjectsIdRunners 2 params → 201400403404
DELETE
/api/v4/projects/{id}/runners/{runner_id}
Unassign a project runner from the project
deleteApiV4ProjectsIdRunnersRunnerId 2 params → 400204403404412
POST
/api/v4/projects/{id}/runners/reset_registration_token
Reset the runner registration token for a project
postApiV4ProjectsIdRunnersResetRegistrationToken 1 param → 201401403404
GET
/api/v4/runners
List available runners
getApiV4Runners 8 params → 200400401
GET
/api/v4/runners/all
List all runners
getApiV4RunnersAll 8 params → 200400401
GET
/api/v4/runners/{id}
Get runner's details
getApiV4RunnersId 2 params → 200401403404
PUT
/api/v4/runners/{id}
Update details of a runner
putApiV4RunnersId 2 params → 200400401403404
DELETE
/api/v4/runners/{id}
Delete a runner
deleteApiV4RunnersId 1 param → 401204403404412
GET
/api/v4/runners/{id}/managers
Get a list of all runner's managers
getApiV4RunnersIdManagers 1 param → 200403
GET
/api/v4/runners/{id}/projects
List runner's projects
getApiV4RunnersIdProjects 3 params → 200401403404
GET
/api/v4/runners/{id}/jobs
List runner's jobs
getApiV4RunnersIdJobs 8 params → 200401403404
POST
/api/v4/runners/{id}/reset_authentication_token
Reset runner's authentication token
postApiV4RunnersIdResetAuthenticationToken 1 param → 201403404422
POST
/api/v4/runners/reset_registration_token
Reset instance's runner registration token
postApiV4RunnersResetRegistrationToken → 201403
POST
/api/v4/user/runners
Create a runner owned by currently authenticated user
postApiV4UserRunners 1 param → 201400403

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are API_Entities_User (27 properties), API_Entities_Ci_RunnerDetails (26 properties), API_Entities_BasicProjectDetails (24 properties), API_Entities_Ci_JobBasicWithProject (20 properties). Each schema is shown below with its type and property counts.

API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
API_Entities_Ci_Runner
object
APIEntitiesCiRunner model
13 properties 12 required
API_Entities_Ci_RunnerManager
object
APIEntitiesCiRunnerManager model
11 properties 11 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
API_Entities_ProjectIdentity
object
7 properties 7 required
API_Entities_User
object
27 properties 21 required
API_Entities_Ci_JobBasicWithProject
object
APIEntitiesCiJobBasicWithProject model
20 properties 19 required
putApiV4RunnersId
object
Update runner's details
9 properties
API_Entities_Ci_PipelineBasic
object
APIEntitiesCiPipelineBasic model
10 properties 10 required
API_Entities_Commit
object
APIEntitiesCommit model
15 properties 15 required
postApiV4ProjectsIdRunners
object
Assign a runner to project
1 property 1 required
API_Entities_NamespaceBasic
object
8 properties 8 required
API_Entities_BasicProjectDetails
object
APIEntitiesBasicProjectDetails model
24 properties 17 required
API_Entities_Ci_ResetTokenResult
object
APIEntitiesCiResetTokenResult model
2 properties 1 required
API_Entities_Ci_RunnerDetails
object
APIEntitiesCiRunnerDetails model
26 properties 24 required
API_Entities_BasicGroupDetails
object
APIEntitiesBasicGroupDetails model
3 properties 3 required
API_Entities_Ci_RunnerRegistrationDetails
object
APIEntitiesCiRunnerRegistrationDetails model
3 properties 3 required
postApiV4UserRunners
object
Create a runner owned by currently authenticated user
13 properties 3 required
API_Entities_LicenseBasic
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-runners-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 runners 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.