GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation triggers the execution of a specific pipeline schedule for a project in GitLab. It is useful for automating the running of predefined pipeline schedules without manual intervention, such as triggering CI/CD pipelines on demand based on schedules set in GitLab projects.

Use Case Examples

  1. Trigger a pipeline schedule to run a build or deployment pipeline for a project automatically at a specific time.
  2. Manually trigger a scheduled pipeline to test changes or run maintenance tasks in a GitLab project.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public endpoints or testing.
Authentication Select the authentication method, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is POST to trigger the pipeline schedule.
Path Parameters Parameters required in the API path to identify the project and pipeline schedule to trigger.

Output

JSON

  • id - The ID of the triggered pipeline schedule run
  • status - The status of the triggered pipeline schedule run
  • ref - The Git reference (branch or tag) for the pipeline run
  • created_at - Timestamp when the pipeline schedule run was created
  • updated_at - Timestamp when the pipeline schedule run was last updated

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to trigger pipeline schedules.
  • Check the base URL is correct for self-hosted GitLab instances.
  • Common errors include 404 Not Found if the project or schedule ID is invalid, and 401 Unauthorized if authentication fails.

Links

Discussion