GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 DevOps teams or administrators who want to manage or monitor runners in their GitLab instance, for example, to audit runner availability, filter runners by type or status, or paginate through large sets of runners.

Use Case Examples

  1. Fetch all active runners of type 'instance_type' to monitor their status.
  2. Retrieve runners tagged with 'macos' and 'shell' to check specific environment runners.
  3. Paginate through runners with 20 runners per page to manage large runner pools.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication Authentication method used for the request, hidden unless Skip Authentication is false. Defaults to GitLab API key.
baseUrl Base URL of the GitLab instance to send requests to. Defaults to https://gitlab.com.
Method HTTP method to use for the request. Defaults to GET.
Query Parameters Collection of optional query parameters to filter and paginate runners.

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

Dependencies

  • GitLab API key credential for authentication

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 instance.
  • Check that query parameters are valid and conform to expected types and values to avoid API errors.
  • Common error messages may include authentication failures, invalid query parameters, or network connectivity issues. Resolving these involves verifying credentials, correcting parameter values, and ensuring network access.

Links

Discussion