GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a list of GitLab runners using the GitLab API v4. It allows filtering runners based on various criteria such as type, status, tags, and version prefix. This is useful for DevOps and CI/CD pipeline management to monitor and manage runners efficiently.

Use Case Examples

  1. Fetch all active runners of a specific type to monitor their status.
  2. Retrieve runners with specific tags to allocate jobs accordingly.
  3. Paginate through runners to handle large sets of runner data.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request.
Parameter Schema Defines the query parameters available for filtering runners, such as scope, type, paused status, runner status, tags, version prefix, pagination page, and items per page.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path The API endpoint path for retrieving runners.
Query Parameters Collection of query parameters to filter and paginate the runners list, including scope, type, paused, status, tag_list, version_prefix, page, and per_page.

Output

JSON

  • ``
    • id - Unique identifier of the runner.
    • description - Description of the runner.
    • status - Current status of the runner (e.g., active, paused).
    • tags - List of tags associated with the runner.
    • type - Type of the runner (e.g., instance_type, group_type, project_type).
    • version - Version of the runner.
    • online - Boolean indicating if the runner is currently online.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the GitLab API credentials are correctly configured and have the necessary permissions to access runners.
  • Verify the baseUrl 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 requests will fail.

Links

Discussion