GitLab API

GitlabTool
Join our community

Actions1000

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 particular pipeline to track deployment progress.

Use Case Examples

  1. Fetch all bridge jobs for pipeline ID 18 in project ID 11.
  2. Retrieve only the running bridge jobs for a specific pipeline to monitor active jobs.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Optional query parameters to filter and paginate the results.
Path Parameters Required path parameters to specify the project and pipeline.

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.
  • web_url - URL to view the bridge job in GitLab.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID and pipeline ID are correctly specified and URL-encoded if necessary.
  • Verify that the authentication token has sufficient permissions to access the project's pipeline data.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • If filtering by scope, ensure the scope value is one of the allowed statuses (e.g., pending, running, success).
  • Pagination parameters (page and per_page) should be positive integers; otherwise, the API may return errors or unexpected results.

Links

Discussion