GitLab API

GitlabTool

Actions1095

Runners → getApiV4GroupsIdRunners

AI-generated

Summary

Retrieve a list of runners registered for a specified GitLab group, optionally filtering by runner type, paused status, status, tags, and version prefix.

Inputs

  • id (required) — The ID of the GitLab group whose runners are to be retrieved.
  • type — Filter runners by their type: instance_type, group_type, or project_type.
  • paused — Filter runners based on whether they are paused (ignoring new jobs) or active.
  • 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 string, e.g., '15.1.' or '16.'.
  • page — Specify the current page number for pagination (default is 1).
  • per_page — Specify the number of runners to retrieve per page (default is 20).
  • skipAuthentication — Option to skip using built-in Gitlab API authentication, default is false.
  • baseUrl — The base URL of the GitLab instance, defaults to 'https://gitlab.com'.
  • method — HTTP method to use, defaults to 'GET'.

Output shape

a list of runner objects associated with the specified GitLab group

Supports pagination through 'page' and 'per_page' query parameters. Returns runners filtered by specified query parameters if provided. Uses GitLab API authentication unless skipped.

Examples

Example 1: List all active runners for a GitLab group with ID '1234', filtering by tag 'macos', showing 10 runners per page page 2.

Set 'id' path parameter to '1234', 'status' query parameter to 'active', 'tag_list' to 'macos', 'per_page' to 10, and 'page' to 2. Use default HTTP GET method and base URL.

Links

Discussion