GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves detailed information about a specific pipeline within a GitLab project using the GitLab API v4. It is useful for scenarios where users need to monitor or analyze the status and details of CI/CD pipelines associated with their projects. For example, it can be used to fetch pipeline results for automated deployment workflows or to integrate pipeline data into reporting dashboards.

Use Case Examples

  1. Fetch the status and details of a pipeline with ID 18 in project 11 to monitor CI/CD progress.
  2. Retrieve pipeline information to trigger subsequent automation steps based on pipeline success or failure.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters Collection of path parameters required for the API endpoint, including the project ID or URL-encoded path and the pipeline ID.

Output

JSON

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

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and pipeline ID are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the project and pipeline data.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct and accessible.

Links

Discussion