GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves pipelines associated with a specific pipeline schedule within a GitLab project. It is useful for users who want to programmatically access pipeline data tied to scheduled pipelines in their GitLab projects, such as for monitoring or automation purposes.

Use Case Examples

  1. Fetch all pipelines triggered by a particular pipeline schedule in a project to analyze their statuses.
  2. Automate the retrieval of pipeline data for scheduled jobs to integrate with other CI/CD tools or dashboards.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request.
Authentication Type of authentication used for the request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method used for the request, default is GET.
Parameter Schema Defines required path parameters for the request: project ID and pipeline schedule ID.
Request Body Schema Schema for the request body, null for this operation as it is a GET request.
Request Path API endpoint path with placeholders for project ID and pipeline schedule ID.
Path Parameters Collection of path parameters including project ID and pipeline schedule ID to specify the target resource.

Output

JSON

  • ``
    • id - The unique identifier of each pipeline.
    • status - The status of each pipeline (e.g., success, failed, running).
    • ref - The branch or tag name the pipeline is associated with.
    • sha - The commit SHA the pipeline was triggered for.
    • web_url - The URL to view the pipeline in GitLab.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correctly provided and URL-encoded if necessary.
  • Authentication errors may occur if the API key is missing or invalid; verify credentials are correctly configured.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • HTTP method should be GET for this operation; using other methods may cause errors.

Links

Discussion