GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation triggers the execution (play) of a specific pipeline schedule within a GitLab project. It is useful for automating the manual start of scheduled pipelines in CI/CD workflows. For example, a user can use this node to programmatically start a pipeline schedule identified by its ID in a given project, enabling integration with other automation or monitoring systems.

Use Case Examples

  1. Trigger a pipeline schedule to run immediately in a GitLab project as part of a deployment automation process.
  2. Manually start a scheduled pipeline from an external workflow or trigger based on certain conditions.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Select the authentication method to use for the API request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters to specify the project and pipeline schedule to target.

Output

JSON

  • statusCode - HTTP status code returned by the API request indicating success or failure.
  • body - The response body from the API, typically containing details about the triggered pipeline schedule execution.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correctly specified and exist in the GitLab instance.
  • Verify that the authentication credentials are valid and have sufficient permissions to trigger pipeline schedules.
  • Check the base URL to confirm it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (invalid project or pipeline schedule ID), and 403 Forbidden (insufficient permissions). Resolving these involves correcting credentials, IDs, or permissions.

Links

Discussion