GitLab API icon

GitLab API

Gitlab

Actions1062

Runners → getApiV4GroupsIdRunners

AI-generated

Summary

Retrieve a list of GitLab runners associated with a specified group, optionally filtering by runner type, paused state, status, tags, version prefix, and paginating the results.

Inputs

  • id (required) — The ID of the group from which to retrieve runners.
  • type — Filter runners by type, such as 'instance_type', 'group_type', or 'project_type'.
  • paused — Filter runners by whether they are paused (ignoring new jobs) or active (accepting new jobs).
  • status — Filter runners by their status; possible values include 'active', 'paused', 'online', 'offline', 'never_contacted', and 'stale'.
  • tag_list — Filter runners by a list of tags. Specify as a comma-separated string representing runner tags.
  • version_prefix — Filter runners by version prefix, such as '15.1.' or '16.' to match runner versions.
  • page — Specify the page number of results to return, used for pagination. Defaults to 1.
  • per_page — Specify the number of items per page in the paginated results. Defaults to 20.

Output shape

a list of runner objects as returned by the GitLab API for the group specified

The output is paginated according to the 'page' and 'per_page' input parameters. Filtering parameters are optional and, if omitted, the API returns runners unfiltered apart from the group association. The node relies on authentication credentials unless the 'Skip Authentication' option is enabled.

Links

Discussion