GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves runners associated with a specific GitLab group by making an API call to the GitLab server. 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 filter runners by type, status, tags, or version prefix, and paginate through the results.

Use Case Examples

  1. Get all active runners for a GitLab group with ID '123'.
  2. Retrieve runners that are currently paused and tagged with 'macos' and 'shell' for a specific group.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Optional filters and pagination parameters for the API request.
Path Parameters The ID of the GitLab group whose runners are being queried.

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.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the group ID provided in the path parameters is correct and exists in GitLab.
  • Verify that the API token used for authentication has sufficient permissions to access group runners.
  • Check network connectivity to the GitLab instance specified by the baseUrl.
  • If filtering by tags or status, ensure the values match the allowed enums to avoid API errors.

Links

Discussion