GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific runner from a project in GitLab using the GitLab API. It is useful for managing CI/CD runners associated with projects, especially when a runner is no longer needed or should be removed for security or maintenance reasons. For example, a DevOps engineer can automate the removal of runners from projects that are deprecated or no longer require certain runners.

Use Case Examples

  1. Automate cleanup of runners from projects that are archived or deleted.
  2. Remove a runner that is malfunctioning or no longer authorized to run jobs on a project.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to DELETE for this operation.
Path Parameters Parameters required in the request path to identify the project and runner to delete.

Output

JSON

  • success - Indicates whether the runner was successfully deleted.
  • statusCode - HTTP status code returned by the API.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID and runner ID are correct and exist in GitLab.
  • Verify that the API authentication credentials have sufficient permissions to delete runners.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages include 404 Not Found if the project or runner does not exist, and 403 Forbidden if the user lacks permission to delete the runner.

Links

Discussion