GitLab API

GitlabTool

Actions1095

Runners → getApiV4RunnersAll

AI-generated

Summary

Retrieve a list of all GitLab runners with optional filtering parameters such as scope, type, status, tags, version prefix, pagination, and paused state.

Inputs

  • skipAuthentication — Boolean to skip authentication; defaults to false.
  • baseUrl — The base URL of the GitLab instance; defaults to https://gitlab.com.
  • method — HTTP method to use; defaults to GET.
  • scope — Deprecated filter for runner scope (use 'type' or 'status' instead).
  • type — Type of runners to return; can be 'instance_type', 'group_type', or 'project_type'.
  • paused — Boolean indicating whether to include only runners that are accepting or ignoring new jobs.
  • status — Status filter for runners; possible values include 'active', 'paused', 'online', 'offline', 'never_contacted', or 'stale'.
  • tag_list — List of tags to filter runners by; accepts multiple tag strings.
  • version_prefix — Version prefix of runners to return, e.g. '15.1.' or '16.'.
  • page — Page number for paginated results; defaults to 1.
  • per_page — Number of items per page for pagination; defaults to 20.

Output shape

a JSON array of runner objects

Supports pagination through 'page' and 'per_page' query parameters; filtering by multiple optional parameters is supported; authentication is required unless 'skipAuthentication' is set to true.

Links

Discussion