GitLab API

GitlabTool

Actions1000

Overview

This node operation allows users to delete GitLab runners' managers via the GitLab API. It is useful for managing and cleaning up runner managers by specifying their authentication token and system identifier. For example, a DevOps engineer can automate the removal of outdated or unused runner managers in their GitLab instance.

Use Case Examples

  1. Automate deletion of a specific runner manager by providing its token and system ID.
  2. Integrate with CI/CD pipelines to manage runner lifecycle by removing managers no longer needed.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
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 but can be set to DELETE for this operation.
Query Parameters Parameters sent as query strings in the API request, specifically the runner's authentication token and system identifier.

Output

JSON

  • statusCode - HTTP status code returned by the API indicating success or failure of the delete operation.
  • responseBody - The JSON response body from the API after attempting to delete the runner manager.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the token and system_id query parameters are correctly provided and valid; missing or incorrect values will cause the API call to fail.
  • If authentication is skipped, the API request may be unauthorized unless the GitLab instance allows anonymous access.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (runner manager not found), and 400 Bad Request (invalid parameters).

Links

Discussion