GitLab API icon

GitLab API

Gitlab

Actions1062

Runners → getApiV4RunnersIdJobs

AI-generated

Summary

Retrieve a list of jobs associated with a specific GitLab runner by its ID, optionally filtering and sorting the results.

Inputs

  • id (required) — The ID of the runner whose jobs are to be retrieved.
  • system_id — System ID associated with the runner manager to filter jobs.
  • status — Status filter to retrieve jobs matching specific states such as 'running', 'success', 'failed', etc.
  • order_by — Field by which to order the jobs; currently supports ordering by 'id'.
  • sort — Sort direction, either ascending ('asc') or descending ('desc'), defaults to 'desc'. Used in conjunction with 'order_by'.
  • cursor — Cursor string for paginating through records sequentially.
  • page — Page number to retrieve for paginated results, defaults to 1.
  • per_page — Number of job records to return per page, defaults to 20.
  • skipAuthentication — Whether to skip using configured authentication; defaults to false.

Output shape

a list of job records associated with the specified runner

Supports pagination via 'page', 'per_page', and cursor. Optional filtering by job status and system_id, and ordering by job ID. Authentication is required unless skipped explicitly.

Examples

Example 1: Retrieve the first page of jobs for runner with ID 123, filtered to only running jobs, sorted descending by job ID.

Set 'id' to 123, 'status' to 'running', 'page' to 1, 'per_page' to desired number (default 20), 'order_by' to 'id', and 'sort' to 'desc'.

Links

Discussion