GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves a list of GitLab runners using the GitLab API v4. It is useful for DevOps teams or administrators who want to manage or monitor runners associated with their GitLab instance. 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. Fetch all active runners of a specific type to monitor their status.
  2. Retrieve runners with specific tags to manage job 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.
baseUrl The base URL of the GitLab instance to connect to.
Method HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
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.
  • 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 GitLab API credentials are correctly configured and have sufficient permissions to access runners.
  • Verify the base URL is correct and accessible from the network where the node runs.
  • Check that query parameters are valid and conform to the expected types and values to avoid API errors.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to runners, otherwise the request will fail.

Links

Discussion