GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves jobs associated with a specific GitLab runner by its ID. It is useful for monitoring and managing CI/CD jobs executed by runners in GitLab. For example, users can filter jobs by status, order results, paginate through job lists, and specify system IDs related to runner managers.

Use Case Examples

  1. Fetch all jobs for a runner with ID 123, filtering only running jobs.
  2. Retrieve jobs for a runner sorted by job ID in descending order, paginated to show 20 jobs per page.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET.
Parameter Schema Defines the parameters accepted by the operation, including path and query parameters such as runner ID, system ID, job status, ordering, sorting, cursor, page, and items per page.
Query Parameters Collection of optional query parameters to filter and paginate the jobs list, including system_id, status, order_by, sort, cursor, page, and per_page.
Path Parameters Collection of path parameters, specifically the runner ID to identify which runner's jobs to retrieve.

Output

JSON

  • jobs - Array of job objects associated with the specified runner, including details such as job status, ID, and other metadata.

Dependencies

  • Requires GitLab API key credential for authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the runner ID provided in path parameters is valid and exists in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access runner job information.
  • Check network connectivity and baseUrl correctness if requests fail to reach the GitLab server.
  • If filtering by status or other query parameters, ensure values are valid as per the allowed enums to avoid API errors.

Links

Discussion