GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a specific pipeline schedule for a project in GitLab using the GitLab API. It is useful for automating the management of pipeline schedules, such as modifying the timing or configuration of scheduled CI/CD pipelines in GitLab projects. For example, a user can update the cron schedule or description of a pipeline schedule programmatically within an n8n workflow.

Use Case Examples

  1. Updating the cron timing of a pipeline schedule for a GitLab project.
  2. Changing the description or active status of a pipeline schedule via an automated workflow.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to PUT for this operation.
Path Parameters Parameters specifying the project ID or URL-encoded path and the pipeline schedule ID to identify the resource to update.

Output

JSON

  • id - The unique identifier of the updated pipeline schedule.
  • description - The description of the pipeline schedule.
  • ref - The Git reference (branch or tag) the pipeline schedule runs on.
  • cron - The cron timing string defining the schedule.
  • cron_timezone - The timezone for the cron schedule.
  • active - Whether the pipeline schedule is active.
  • next_run_at - The timestamp of the next scheduled run.
  • owner
    • id - The ID of the owner of the pipeline schedule.
    • name - The name of the owner of the pipeline schedule.
    • username - The username of the owner of the pipeline schedule.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in GitLab to avoid 404 errors.
  • Verify that the API key used has sufficient permissions to update pipeline schedules.
  • Check the format of the request body to match the expected schema to prevent validation errors.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests, otherwise the request will fail.

Links

Discussion