GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a list of runners associated with a specific GitLab group by making a GET request to the GitLab API endpoint `/api/v4/groups/{id}/runners`. It supports filtering runners by type, paused status, runner status, tags, version prefix, and pagination options. This is useful for DevOps teams or administrators who want to manage or monitor CI/CD runners within a GitLab group.

Use Case Examples

  1. Fetch all runners for a GitLab group with ID '123'.
  2. Filter runners to only include those that are active and have specific tags like 'macos' and 'shell'.
  3. Paginate through runners to handle large groups with many runners.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request, hidden unless Skip Authentication is false. Defaults to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send requests to. Defaults to https://gitlab.com.
Method HTTP method to use for the request. Defaults to GET.
Parameter Schema Defines the parameters for the API request including path and query parameters such as group ID, runner type, paused status, runner status, tags, version prefix, page number, and items per page.
Query Parameters Collection of optional query parameters to filter and paginate the runners list, including type, paused, status, tag_list, version_prefix, page, and per_page.
Path Parameters Collection of path parameters, specifically the group ID to identify which group's runners to retrieve.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Indicates if the runner is active.
  • status - Current status of the runner (e.g., active, paused, online).
  • tags - List of tags associated with the runner.
  • version - Version of the runner.
  • runner_type - Type of the runner (instance, group, or project).
  • created_at - Timestamp when the runner was created.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID path parameter is provided and valid; missing or incorrect ID will cause request failures.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions; verify credentials.
  • Invalid query parameters (e.g., unsupported status or type values) may result in API errors; use only supported enum values.
  • Pagination parameters should be integers; non-integer values may cause errors or unexpected results.

Links

Discussion