GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdPlay

AI-generated

Summary

Trigger a play of a specific pipeline schedule for a given GitLab project by specifying the project ID (or URL-encoded path) and the pipeline schedule ID.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project to trigger the pipeline schedule for.
  • pipeline_schedule_id (required) — The ID of the pipeline schedule within the project to play.

Output shape

a single API response object from the GitLab endpoint indicating the pipeline schedule play action result

The operation returns the JSON response from the GitLab API call to play the pipeline schedule, containing details of the triggered pipeline. No pagination applies.

Examples

Example 1: Trigger the pipeline schedule with ID 13 in the project with ID 18, causing GitLab to run that scheduled pipeline immediately.

Set 'id' to '18', 'pipeline_schedule_id' to '13', and use the POST method on the path '/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/play'.

Links

Discussion