GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves pipelines for a specific project from the GitLab API (v4). It allows users to fetch detailed pipeline information by specifying the project ID or URL-encoded path and supports various query parameters to filter and sort the pipelines. This is useful for DevOps teams and developers who want to monitor CI/CD pipeline statuses, filter pipelines by status, scope, or other attributes, and integrate pipeline data into their workflows.

Use Case Examples

  1. Fetch all pipelines for project ID 11 with default pagination.
  2. Retrieve running pipelines for a project filtered by branch or tag.
  3. Get pipelines updated after a specific date to monitor recent CI/CD activity.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, default is https://gitlab.com.
Method HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH). Default is GET.
Query Parameters Collection of optional query parameters to filter and sort the pipelines, such as page, per_page, scope, status, ref, sha, yaml_errors, username, updated_before, updated_after, order_by, sort, source, and name.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project whose pipelines are being retrieved.

Output

JSON

  • pipelines - Array of pipeline objects returned from the GitLab API, each containing details about individual pipelines such as status, ref, sha, user, and timestamps.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct and accessible with the provided authentication.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check that the query parameters are valid and conform to the GitLab API specifications to avoid request errors.
  • Authentication errors may occur if the API key is missing, invalid, or lacks necessary permissions.

Links

Discussion