GitLab API

GitlabTool
Join our community

Actions905

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 pipelines in a CI/CD workflow. For example, a user can update the schedule of a pipeline to run at different intervals or change its parameters programmatically.

Use Case Examples

  1. Updating the schedule of a pipeline in a GitLab project to run nightly instead of weekly.
  2. Modifying the configuration of an existing pipeline schedule to include new variables or change the branch it runs on.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is PUT for this operation.
Path Parameters Parameters required in the URL path to identify the project and pipeline schedule to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the pipeline schedule, containing details of the updated schedule.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in GitLab to avoid 404 errors.
  • Verify that the API token used has sufficient permissions to update pipeline schedules in the project.
  • Check the request body schema matches the expected format to prevent validation errors from the API.

Links

Discussion