GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves runners associated with a specific GitLab group using the GitLab API. It is useful for DevOps teams or administrators who want to manage or monitor CI/CD runners linked to a group in GitLab. For example, it can be used to list all active or paused runners for a group, filter runners by tags, or paginate through large sets of runners.

Use Case Examples

  1. Retrieve all runners for a GitLab group by specifying the group ID.
  2. Filter runners by their status (e.g., active or paused) to monitor runner availability.
  3. Use pagination parameters to fetch runners in batches for large groups.

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.
Query Parameters Optional filters and pagination parameters for the request.
Path Parameters Path parameter specifying the ID of the group whose runners are being retrieved.

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.
  • tags - List of tags associated with the runner.
  • version - Version of the runner.
  • runner_type - Type of the runner (instance, group, project).

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID path parameter is correctly set; missing or incorrect ID will cause request failures.
  • Verify that the authentication token has sufficient permissions to access group runners.
  • Check the base URL if using a self-hosted GitLab instance to avoid connection errors.
  • Pagination parameters (page, per_page) should be set correctly to avoid incomplete data retrieval.

Links

Discussion