GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves the runners associated with a specific GitLab project using the GitLab API v4. It is useful for DevOps teams and project managers who want to monitor or manage the runners assigned to their projects. For example, it can be used to list all runners for a project, filter runners by type, status, or tags, and paginate through the results.

Use Case Examples

  1. List all runners for a project by providing the project ID.
  2. Filter runners to show only active or paused runners.
  3. Retrieve runners with specific tags like 'macos' or 'shell'.
  4. Paginate through runners if there are many, by specifying page number and items per page.

Properties

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

Output

JSON

  • ``
    • id - The unique identifier of each runner.
    • description - Description of the runner.
    • active - Indicates if the runner is active.
    • status - Current status of the runner (e.g., active, paused, online).
    • tags - List of tags associated with the runner.
    • version - Version of the runner.
    • runner_type - Type of the runner (instance, group, or project).

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID is correct and accessible by the authenticated user to avoid 404 errors.
  • Check that the API key has sufficient permissions to read project runners to avoid authorization errors.
  • If filtering by tags or status, ensure the values are valid and supported by the GitLab API to avoid empty results or errors.
  • Pagination parameters should be valid integers; otherwise, the API may return errors or unexpected results.

Links

Discussion