GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 pipeline executions in their GitLab projects. For example, a DevOps engineer might use this to monitor or analyze scheduled pipeline runs for a project.

Use Case Examples

  1. Retrieve all pipelines triggered by a specific pipeline schedule in a project to monitor their status and results.
  2. Fetch pipeline details for scheduled CI/CD runs to integrate with external reporting tools.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used for the request, defaulting to GET.
Parameter Schema Defines required path parameters for the request: project ID or URL-encoded path and pipeline schedule ID.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path API endpoint path template for accessing pipelines of a pipeline schedule in a project.
Path Parameters Collection of path parameters including 'id' (project ID or path) and 'pipeline_schedule_id' (pipeline schedule ID) used to construct the request URL.

Output

JSON

  • ``
    • id - The unique identifier of each pipeline.
    • status - The status of each pipeline (e.g., running, success, failed).
    • 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 correct and exist in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access pipeline schedules and pipelines.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project or pipeline schedule does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion