GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves jobs for a specific pipeline within a GitLab project using the GitLab API v4. It is useful for DevOps and CI/CD workflows where users need to monitor or analyze the status and details of jobs executed in a pipeline. For example, it can be used to fetch all jobs of a pipeline to check which jobs succeeded, failed, or are still running.

Use Case Examples

  1. Fetch all jobs for pipeline ID 18 in project ID 11 to monitor pipeline execution status.
  2. Retrieve only running or pending jobs for a specific pipeline to trigger notifications or further automation.

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 authentication.
baseUrl The base URL of the GitLab instance to send the API request to, default is https://gitlab.com.
Method The HTTP method used for the API request, default is GET.
Parameter Schema Defines the path and query parameters for the API request, including project ID, pipeline ID, and optional filters like include_retried, scope, page, and per_page.
Query Parameters Optional query parameters to filter and paginate the jobs list, such as include_retried, scope, page, and per_page.
Path Parameters Path parameters specifying the project ID and pipeline ID to identify the pipeline whose jobs are being retrieved.

Output

JSON

  • jobs - List of jobs retrieved from the specified pipeline in the project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and pipeline ID are correct and exist in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access pipeline jobs.
  • Check network connectivity and base URL correctness if the request fails to reach the GitLab server.
  • If authentication is skipped, ensure the GitLab instance allows unauthenticated access to the requested resource.

Links

Discussion