GitLab API

GitlabTool
Join our community

Actions1000

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 by removing those that are no longer needed or should no longer be associated with a project. For example, a DevOps engineer might use this node to automate the cleanup of runners after project completion or to revoke access for a compromised runner.

Use Case Examples

  1. Deleting a runner with ID 123 from a project with ID 'my-project' to ensure it no longer executes jobs for that project.
  2. Automating runner management by removing runners that are inactive or no longer authorized.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically a GitLab API key.
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 DELETE is used for this operation.
Path Parameters Parameters required in the API path to identify the project and runner to delete.

Output

JSON

  • statusCode - HTTP status code returned by the API after attempting to delete the runner.
  • responseBody - The body of the API response, typically empty or containing confirmation of deletion.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID and runner ID are correct and exist in the GitLab instance.
  • Verify that the API token has sufficient permissions to delete runners from the project.
  • If skipping authentication, the request will likely fail unless the GitLab instance allows unauthenticated access for this operation.

Links

Discussion