GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves a list of all GitLab runners using the GitLab API v4 endpoint `/api/v4/runners/all`. It supports filtering runners by various query parameters such as scope, type, paused status, runner status, tags, version prefix, and pagination options. This operation is useful for administrators or DevOps engineers who want to manage or monitor runners across their GitLab instance, including shared, group, or project runners.

Use Case Examples

  1. Fetch all active runners with specific tags for monitoring purposes.
  2. Retrieve paused runners to troubleshoot why they are not accepting jobs.
  3. List runners filtered by version prefix to ensure compatibility with CI/CD pipelines.

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.
baseUrl The base URL of the GitLab instance to send the API request to. Defaults to https://gitlab.com.
Method HTTP method to use for the API request. Defaults to GET.
Query Parameters Collection of optional query parameters to filter and paginate the runners list.

Output

JSON

  • id - Unique identifier of the runner.
  • description - Description of the runner.
  • active - Boolean indicating if the runner is active.
  • is_shared - Boolean indicating if the runner is shared.
  • status - Current status of the runner (e.g., active, paused).
  • tags - List of tags associated with the runner.
  • version - Version of the runner software.
  • runner_type - Type of the runner (instance, group, project).
  • created_at - Timestamp when the runner was created.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access runner information.
  • Verify the baseUrl is correct and accessible from the n8n environment.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to the runners endpoint, otherwise the request will fail.
  • Check query parameter values for correctness, especially enums like status and type, to avoid API errors.

Links

  • GitLab API - List all runners - Official GitLab API documentation for listing all runners with available query parameters and response details.

Discussion