GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves bridge jobs for a specific pipeline within a GitLab project using the GitLab API. It is useful for users who want to monitor or manage pipeline bridge jobs, such as viewing their status or filtering them by scope. For example, a DevOps engineer might use this node to fetch all running or pending bridge jobs for a given pipeline to track deployment progress.

Use Case Examples

  1. Fetch all bridge jobs for project ID 11 and pipeline ID 18.
  2. Filter bridge jobs by scope, such as only 'running' or 'pending' jobs.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to send the request to.
Method The HTTP method used for the API request.
Parameter Schema Defines the path and query parameters for the API request, including project ID, pipeline ID, scope filter, pagination page, and items per page.
Query Parameters Optional query parameters to filter and paginate the bridge jobs, including scope, page number, and items per page.
Path Parameters Path parameters specifying the project ID and pipeline ID to identify the pipeline whose bridge jobs are being retrieved.

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., running, pending, 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 authentication credential

Troubleshooting

  • Ensure the project ID and pipeline ID are correct and exist in the GitLab instance.
  • Verify that the API authentication token is valid and has sufficient permissions to access pipeline bridge jobs.
  • Check the base URL to confirm it points to the correct GitLab instance.
  • If filtering by scope, ensure the scope value is one of the allowed enums (e.g., running, pending).
  • Pagination parameters (page and per_page) should be positive integers; otherwise, the API may return errors or unexpected results.

Links

Discussion