GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 is useful for scenarios where you need to manage or monitor CI/CD runners within a GitLab group, such as filtering runners by type, status, tags, or version prefix, and paginating through the results.

Use Case Examples

  1. Fetch all active runners for a GitLab group to monitor their status.
  2. Retrieve runners filtered by specific tags to manage runner assignments.
  3. Paginate through runners to display them in a custom dashboard.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters accepted by the API endpoint, including path and query parameters such as group ID, runner type, paused status, runner status, tag list, 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 required for the request, specifically the group ID.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Indicates if the runner is active.
  • is_shared - Indicates if the runner is shared across projects.
  • status - Current status of the runner (e.g., active, paused, online).
  • tags - List of tags associated with the runner.
  • version - Version of the runner software.
  • runner_type - Type of the runner (instance, group, or project).

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID path parameter is correctly provided; missing or incorrect ID will cause request failure.
  • Verify that the authentication token is valid and has sufficient permissions to access group runners.
  • Check query parameter formats, especially for arrays like tag_list, to avoid malformed requests.
  • API rate limits may affect the ability to retrieve runners; handle rate limit errors gracefully.

Links

Discussion