GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves detailed information about a specific GitLab runner by its ID using the GitLab API v4. It is useful for scenarios where you need to fetch runner details for monitoring, management, or integration purposes within GitLab CI/CD workflows.

Use Case Examples

  1. Fetch details of a runner with a specific ID to check its status and configuration.
  2. Integrate runner information retrieval into an automation workflow to dynamically manage CI/CD runners.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication step when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters The path parameter 'id' specifying the ID of the runner to retrieve.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Indicates if the runner is active.
  • is_shared - Indicates if the runner is shared across projects.
  • runner_type - Type of the runner (e.g., instance, group, project).
  • status - Current status of the runner.
  • platform - Platform on which the runner is running.
  • architecture - Architecture of the runner's system.
  • tags - Tags associated with the runner.
  • created_at - Timestamp when the runner was created.
  • updated_at - Timestamp when the runner was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the runner ID provided in the path parameters is valid and exists in the GitLab instance.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions to access runner details.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 404 Not Found if the runner ID does not exist, and 401 Unauthorized if authentication fails. Verify credentials and permissions to resolve these errors.

Links

Discussion