GitLab API

GitlabTool
Join our community

Actions1000

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 runners assigned to a group in GitLab, 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 (boolean). Defaults to false.
baseUrl The base URL of the GitLab instance to send the request to. Defaults to https://gitlab.com.
Method HTTP method to use for the request. Defaults to GET.
Query Parameters Optional filters and pagination parameters for the request.
Path Parameters Path parameter specifying the group ID whose runners are to be retrieved.

Output

JSON

  • id - 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 software.
  • runner_type - Type of the runner (instance, group, project).

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the group ID path parameter is correctly set and valid to avoid 404 errors.
  • Verify that the API authentication token is valid and has sufficient permissions to access group runners.
  • Check that query parameters are correctly formatted, especially arrays like tag_list, to prevent request errors.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to runners, otherwise the request will fail.

Links

Discussion