GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to verify GitLab runners by sending a POST request to the GitLab API endpoint `/api/v4/runners/verify`. It is useful for scenarios where you need to programmatically confirm the validity or status of runners in a GitLab environment, such as in CI/CD pipeline management or automation workflows involving GitLab runners.

Use Case Examples

  1. Verifying a GitLab runner before triggering a pipeline to ensure the runner is active and authorized.
  2. Automating the validation of runners in a GitLab project to maintain CI/CD infrastructure health.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the 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.
Method The HTTP method used for the request, default is POST for this operation.
Parameter Schema Defines the schema for the parameters sent in the request body, required for this operation.
Request Body Schema Schema for the request body, used to validate the data sent in the POST request.
Request Path The API endpoint path for verifying runners, fixed as `/api/v4/runners/verify`.

Output

JSON

  • response - The JSON response from the GitLab API after verifying the runner, containing verification details.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • If authentication is skipped but the GitLab instance requires it, the request will fail with an authentication error. Ensure the correct API key is provided or skipAuthentication is set appropriately.
  • Incorrect baseUrl can lead to connection errors or 404 responses. Verify the GitLab instance URL is correct.
  • Invalid request body parameters may cause the API to return validation errors. Ensure the request body matches the expected schema for runner verification.

Links

Discussion