GitLab API

GitlabTool

Actions1095

Projects → putApiV4ProjectsIdPipelineSchedulesPipelineScheduleId

AI-generated

Summary

Update an existing pipeline schedule for a specified GitLab project by providing the project ID or URL-encoded path and the pipeline schedule ID, along with the updated schedule details in the request body.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project where the pipeline schedule is defined.
  • pipeline_schedule_id (required) — The ID of the pipeline schedule to update.
  • requestBody (required) — A JSON object representing the updated pipeline schedule attributes according to the GitLab API schema (such as description, cron schedule, active status).
  • skipAuthentication — If true, bypass the configured authentication credentials for this request.
  • baseUrl — Optional override of the GitLab base URL; defaults to https://gitlab.com if not specified.

Output shape

a single JSON object representing the updated pipeline schedule as returned by the GitLab API

The operation performs an HTTP PUT request to the path /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id} and returns the updated pipeline schedule details. Authentication is required unless explicitly skipped. No pagination applies to this endpoint.

Examples

Example 1: Update pipeline schedule description and cron timing

Set 'id' to the project ID or path, 'pipeline_schedule_id' to the schedule's ID, and provide the updated schedule fields in the request body.

Links

Discussion