GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a list of runners associated with a specific GitLab project using the GitLab API v4. It is useful for DevOps teams and developers who want to manage or monitor CI/CD runners assigned to their projects. For example, it can be used to filter runners by type, status, tags, or version prefix, helping to identify available or active runners for job execution.

Use Case Examples

  1. Fetch all runners for a project by providing the project ID.
  2. Filter runners by status (e.g., active or paused) to monitor runner availability.
  3. Retrieve runners with specific tags to manage runner groups.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically a GitLab API key.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, default is GET.
Parameter Schema Defines the parameters for the API request including path and query parameters such as project ID, scope, type, status, tags, pagination, etc.
Query Parameters Collection of optional query parameters to filter the runners list, including scope, type, paused status, runner status, tags, version prefix, page number, and items per page.
Path Parameters Collection of path parameters, specifically the project ID or URL-encoded path identifying the project.

Output

JSON

  • runners - Array of runner objects returned from the GitLab API, each representing a runner associated with the specified project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project runners.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If filtering by query parameters, ensure the values conform to the expected enums or formats to avoid API errors.

Links

Discussion