GitLab API icon

GitLab API

Gitlab

Actions1062

Groups → getApiV4GroupsIdRunners

AI-generated

Summary

Retrieve a list of CI/CD runners associated with a specific GitLab group, optionally filtering by runner type, status, tags, version prefix, and pagination parameters.

Inputs

  • id (required) — The ID of the GitLab group for which to fetch runners.
  • type — Filter runners by type: instance_type, group_type, or project_type.
  • paused — Filter runners to only those that are currently accepting or ignoring new jobs.
  • status — Filter runners by their status: active, paused, online, offline, never_contacted, or stale.
  • tag_list — Filter runners by a list of tags.
  • version_prefix — Filter runners by a version prefix, such as '15.1.' or '16.'.
  • page — Specify the page number of results to retrieve, defaults to 1.
  • per_page — Number of runners to return per page, defaults to 20.

Output shape

a list of runner objects corresponding to the group and filters applied

Results are paginated based on 'page' and 'per_page' inputs. Filtering parameters are optional. Authentication is required unless explicitly skipped.

Examples

Example 1: Get all runners for group ID '12345' filtering only active online runners with tag 'macos'

Set 'id' to '12345'; set 'status' to 'active'; set 'paused' to false; set 'tag_list' to ['macos']

Example 2: Retrieve the second page of runners with 10 runners per page for group '67890'

Set 'id' to '67890'; set 'page' to 2; set 'per_page' to 10

Links

Discussion