GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → getApiV4ProjectsIdRunners

AI-generated

Summary

Retrieve a list of runners associated with a specific GitLab project, optionally filtered by various criteria such as type, status, tags, and version.

Inputs

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

Output shape

a paginated list of runner objects associated with the specified GitLab project

Response supports pagination through 'page' and 'per_page' query parameters. Filtering by deprecated 'scope' is supported but discouraged in favor of 'type' and 'status'. Authentication is required unless 'Skip Authentication' is enabled.

Examples

Example 1: Fetch runners for a project with ID '123' filtering for 'active' status and 'project_type' runners.

Set the 'id' path parameter to '123', 'type' query parameter to 'project_type', and 'status' query parameter to 'active'.

Links

Discussion