GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves pipelines for a specific project from the GitLab API (v4). It is useful for users who want to monitor or analyze the CI/CD pipelines associated with a GitLab project. For example, a user can fetch all pipelines for a project to check their status, filter pipelines by branch or status, or paginate through pipeline results.

Use Case Examples

  1. Fetch all pipelines for project ID 11.
  2. Retrieve pipelines filtered by status 'pending' and branch 'develop'.
  3. Get pipelines updated after a specific date for audit purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
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, default is GET.
Parameter Schema Defines the parameters for the API request including path and query parameters such as project ID, pagination, filtering by scope, status, ref, sha, username, date filters, ordering, and source of pipelines.
Query Parameters Collection of optional query parameters to filter and paginate the pipeline results, such as page number, items per page, scope, status, ref, sha, yaml errors, username, updated before/after, order by, sort, source, and name.
Path Parameters Collection of path parameters including the project ID or URL-encoded path to specify which project's pipelines to retrieve.

Output

JSON

  • id - The unique identifier of the pipeline.
  • status - The current status of the pipeline (e.g., running, pending, success).
  • ref - The branch or tag reference for the pipeline.
  • sha - The commit SHA associated with the pipeline.
  • updated_at - The timestamp when the pipeline was last updated.
  • user
    • username - The username of the user who triggered the pipeline.
  • source - The source of the pipeline trigger (e.g., push, web, schedule).
  • name - The name of the pipeline.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct to avoid 404 errors.
  • Verify that the API key credential has sufficient permissions to access the project's pipelines.
  • Check that the base URL is correct if using a self-hosted GitLab instance.
  • If filtering by date, ensure the date format is ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
  • Pagination parameters (page, per_page) should be valid integers to avoid request errors.

Links

Discussion