GitLab API

GitlabTool

Actions1095

Runners → getApiV4ProjectsIdRunners

AI-generated

Summary

Retrieve a list of GitLab runners associated with a specific project by its ID or URL-encoded path, optionally filtering by runner type, status, tags, version prefix, and pagination parameters.

Inputs

  • id (required) — The ID or URL-encoded path of the project owned by the authenticated user.
  • scope — Deprecated filter for the scope of runners to return; use 'type' or 'status' instead.
  • type — Filter runners by their type (instance_type, group_type, project_type).
  • paused — Boolean to include only runners that are paused (ignoring jobs) or active.
  • status — Filter runners by status (active, paused, online, offline, never_contacted, stale).
  • tag_list — List of runner tags to filter by.
  • version_prefix — Filter runners by version prefix string, e.g. '15.1.' or '16.'.
  • page — Page number for paginated results (default 1).
  • per_page — Number of runners returned per page (default 20).

Output shape

a list of runner objects associated with the specified project

Supports pagination via 'page' and 'per_page' query parameters. Filtering parameters are optional. Requires authentication unless 'Skip Authentication' is enabled.

Examples

Example 1: Retrieve first page of active project runners of type 'project_type' tagged with 'macos' and 'shell'

Set 'id' to project ID/path, 'status' to 'active', 'type' to 'project_type', 'tag_list' to ['macos','shell'], and use default pagination.

Links

Discussion