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

Operations about jobs

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

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

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

7 operations 6 paths 11 schemas 2 GET1 PATCH3 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 jobs 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 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

jobs 7

Operations about jobs

GET
/api/v4/runners/{id}/jobs
List runner's jobs
getApiV4RunnersIdJobs 8 params → 200401403404
POST
/api/v4/jobs/request
Request a job
postApiV4JobsRequest 1 param → 201204403409422429
PUT
/api/v4/jobs/{id}
Update a job
putApiV4JobsId 2 params → 200202400403409429
PATCH
/api/v4/jobs/{id}/trace
Append a patch to the job trace
patchApiV4JobsIdTrace 2 params → 202400403416429
POST
/api/v4/jobs/{id}/artifacts/authorize
Authorize uploading job artifact
postApiV4JobsIdArtifactsAuthorize 2 params → 200403405413429
POST
/api/v4/jobs/{id}/artifacts
Upload a job artifact
postApiV4JobsIdArtifacts 2 params → 201400403405413429
GET
/api/v4/jobs/{id}/artifacts
Download the artifacts file for job
getApiV4JobsIdArtifacts 3 params → 200302401403404429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are API_Entities_User (27 properties), API_Entities_Ci_JobBasicWithProject (20 properties), API_Entities_Commit (15 properties), API_Entities_Ci_PipelineBasic (10 properties). Each schema is shown below with its type and property counts.

API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
postApiV4JobsRequest
object
Request a job
5 properties 1 required
API_Entities_Ci_PipelineBasic
object
APIEntitiesCiPipelineBasic model
10 properties 10 required
patchApiV4JobsIdTrace
object
Append a patch to the job trace
2 properties
postApiV4JobsIdArtifacts
object
Upload a job artifact
7 properties 1 required
API_Entities_Commit
object
APIEntitiesCommit model
15 properties 15 required
API_Entities_ProjectIdentity
object
7 properties 7 required
postApiV4JobsIdArtifactsAuthorize
object
Authorize uploading job artifact
3 properties
putApiV4JobsId
object
Update a job
6 properties 1 required
API_Entities_User
object
27 properties 21 required
API_Entities_Ci_JobBasicWithProject
object
APIEntitiesCiJobBasicWithProject model
20 properties 19 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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