GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves bridge jobs for a specific pipeline within a GitLab project using the GitLab API v4. It is useful for users who want to monitor or manage pipeline bridge jobs, such as checking their status or filtering them by scope. For example, a DevOps engineer might use this to automate the monitoring of pipeline bridges in a CI/CD workflow.

Use Case Examples

  1. Retrieve all bridge jobs for pipeline ID 18 in project ID 11.
  2. Filter bridge jobs by status scope such as 'pending' or 'running'.
  3. Paginate through bridge jobs results by specifying page number and items per page.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the path and query parameters for the API call, including project ID, pipeline ID, scope filter, pagination page, and items per page.
Query Parameters Additional query parameters to filter and paginate the results, including scope, page, and per_page.
Path Parameters Path parameters specifying the project ID and pipeline ID for the API endpoint.

Output

JSON

  • id - The unique identifier of the bridge job.
  • name - The name of the bridge job.
  • status - The current status of the bridge job (e.g., pending, running, success).
  • created_at - Timestamp when the bridge job was created.
  • updated_at - Timestamp when the bridge job was last updated.
  • pipeline_id - The ID of the pipeline to which the bridge job belongs.
  • project_id - The ID of the project containing the pipeline.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and pipeline ID are correct and accessible with the provided API key.
  • Check that the API key has sufficient permissions to read pipeline bridge jobs.
  • Verify the base URL is correct for the GitLab instance being accessed.
  • If filtering by scope, ensure the scope value is one of the allowed enums (e.g., pending, running, success).
  • Pagination parameters (page and per_page) should be valid integers to avoid request errors.

Links

Discussion