GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows verifying a GitLab runner by sending a POST request to the GitLab API endpoint `/api/v4/runners/verify`. It is useful for confirming the validity and status of a runner in GitLab CI/CD pipelines. Typical use cases include automating runner verification during CI/CD setup or maintenance.

Use Case Examples

  1. Automate verification of a newly registered GitLab runner to ensure it is active and properly configured.
  2. Periodically verify runners in a GitLab instance to maintain CI/CD pipeline health.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Specifies the authentication method to use for the API request, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to POST for this operation.
Parameter Schema Defines the schema for the request body parameters required for verifying the runner. This is a hidden property used internally for validation.
Request Body Schema Holds the schema for the request body, used internally and hidden from the user.
Request Path The API endpoint path for runner verification, fixed to `/api/v4/runners/verify` and hidden from the user.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Boolean indicating if the runner is active.
  • is_shared - Boolean indicating if the runner is shared across projects.
  • runner_type - Type of the runner (e.g., instance, group, project).
  • status - Current status of the runner.
  • tags - Array of tags associated with the runner.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to verify runners.
  • If skipping authentication, verify that the GitLab instance allows unauthenticated requests to the runner verification endpoint.
  • Common error messages include 401 Unauthorized (invalid or missing API key) and 404 Not Found (incorrect base URL or runner ID). Verify the base URL and request path are correct.

Links

Discussion