GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 you want to remove a runner that is no longer needed or should no longer have access to the project. For example, if a runner is decommissioned or replaced, this operation helps keep the project configuration clean by removing the runner association.

Use Case Examples

  1. Deleting a runner from a project to revoke its access and stop it from running jobs for that project.
  2. Automating cleanup of runners in projects when scaling down CI/CD infrastructure.

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 key 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 The path parameters required for the API request, including the project ID or URL-encoded path and the runner ID to be deleted.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and runner ID are correct and exist in GitLab.
  • Verify that the API key used has sufficient permissions to delete runners from the project.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error: 404 Not Found - The project or runner ID does not exist or is not accessible.
  • Common error: 401 Unauthorized - Authentication failed or API key is invalid.

Links

Discussion