GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to retrieve information about a specific runner by its ID. It is useful for DevOps and CI/CD pipeline automation where you need to programmatically access runner details in GitLab. For example, you can use this node to fetch runner status or configuration as part of a workflow that manages GitLab runners.

Use Case Examples

  1. Retrieve details of a GitLab runner by specifying its ID to monitor runner status or troubleshoot issues.
  2. Automate the management of GitLab runners by integrating this node into a CI/CD pipeline to fetch runner information dynamically.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request, default is GET.
Path Parameters Parameters included in the API request path, specifically the runner ID to identify which 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 (e.g., online, offline).
  • 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 for authentication

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 information.
  • Check the base URL 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