GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a specific GitLab runner by its ID. It is useful for managing GitLab CI/CD runners, especially when you need to remove runners that are no longer needed or are being replaced. For example, a DevOps engineer can automate the cleanup of inactive or obsolete runners in their GitLab instance using this node.

Use Case Examples

  1. Automate deletion of a GitLab runner by specifying its ID to keep the CI/CD environment clean.
  2. Remove a runner that is malfunctioning or no longer required in a GitLab project.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for 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.
Method The HTTP method used for the API request, default is GET but can be set to DELETE for this operation.
Path Parameters Parameters included in the request path, specifically the runner ID to delete.

Output

JSON

  • id - The ID of the runner that was deleted.
  • statusCode - The HTTP status code returned from the API after the delete operation.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the runner ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to delete runners.
  • Check the base URL to confirm it points to the correct GitLab instance.
  • Common error messages include 404 Not Found if the runner ID does not exist, and 403 Forbidden if the API key lacks delete permissions.

Discussion