GitLab API

GitlabTool
Join our community

Actions905

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 track job execution details for a given runner.

Use Case Examples

  1. Fetch all jobs for runner ID 123 with status 'running' to monitor active jobs.
  2. Retrieve jobs for a runner with pagination to analyze job history over time.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to filter and paginate the jobs list.
Path Parameters Path parameter specifying the runner ID to fetch jobs for.

Output

JSON

  • id - Unique identifier of the job.
  • status - Current status of the job.
  • runner_id - ID of the runner executing the job.
  • created_at - Timestamp when the job was created.
  • started_at - Timestamp when the job started.
  • finished_at - Timestamp when the job finished.
  • duration - Duration of the job execution.
  • user - User who triggered the job.
  • pipeline_id - ID of the pipeline the job belongs to.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the runner ID provided in the path parameter is valid and exists in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access runner jobs.
  • Check network connectivity and base URL correctness if requests fail.
  • If pagination parameters are used, ensure they are valid integers or strings as expected by the API.

Links

Discussion