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

Operations about pipeline_schedules

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

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

12 operations 7 paths 11 schemas 2 DELETE4 GET4 POST2 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 pipeline_schedules 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 12

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

pipeline_schedules 12

Operations about pipelineschedules

GET
/api/v4/projects/{id}/pipeline_schedules
Get all pipeline schedules
getApiV4ProjectsIdPipelineSchedules 4 params → 200401403404
POST
/api/v4/projects/{id}/pipeline_schedules
Create a new pipeline schedule
postApiV4ProjectsIdPipelineSchedules 2 params → 201400401403404
GET
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}
Get a single pipeline schedule
getApiV4ProjectsIdPipelineSchedulesPipelineScheduleId 2 params → 200401403404
PUT
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}
Edit a pipeline schedule
putApiV4ProjectsIdPipelineSchedulesPipelineScheduleId 3 params → 200400401403404
DELETE
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}
Delete a pipeline schedule
deleteApiV4ProjectsIdPipelineSchedulesPipelineScheduleId 2 params → 204401403404412
GET
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/pipelines
Get all pipelines triggered from a pipeline schedule
getApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdPipelines 11 params → 200401403404
POST
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/take_ownership
Take ownership of a pipeline schedule
postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdTakeOwnership 2 params → 201400401403404
POST
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/play
Play a scheduled pipeline immediately
postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdPlay 2 params → 201401403404
POST
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables
Create a new pipeline schedule variable
postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariables 3 params → 201400401403404
GET
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}
Get a single pipeline schedule variable
getApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey 3 params → 200401403404
PUT
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}
Edit a pipeline schedule variable
putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey 4 params → 200400401403404
DELETE
/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}
Delete a pipeline schedule variable
deleteApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey 3 params → 202401403404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are API_Entities_Ci_PipelineScheduleDetails (13 properties), API_Entities_Ci_PipelineSchedule (11 properties), API_Entities_Ci_PipelineBasic (10 properties), API_Entities_UserBasic (10 properties). Each schema is shown below with its type and property counts.

postApiV4ProjectsIdPipelineSchedules
object
Create a new pipeline schedule
6 properties 3 required
API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
putApiV4ProjectsIdPipelineSchedulesPipelineScheduleId
object
Edit a pipeline schedule
6 properties
API_Entities_Ci_PipelineBasic
object
APIEntitiesCiPipelineBasic model
10 properties 10 required
API_Entities_Ci_Input
object
2 properties 2 required
API_Entities_Ci_PipelineSchedule
object
APIEntitiesCiPipelineSchedule model
11 properties 10 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey
object
Edit a pipeline schedule variable
2 properties
API_Entities_Ci_PipelineScheduleDetails
object
APIEntitiesCiPipelineScheduleDetails model
13 properties 11 required
API_Entities_Ci_Variable
object
APIEntitiesCiVariable model
9 properties 3 required
postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariables
object
Create a new pipeline schedule variable
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-pipeline-schedules-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 pipeline_schedules 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.