GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific project hook in a GitLab project using the GitLab API. It is useful for managing project webhooks by removing hooks that are no longer needed or valid. For example, if a webhook was set up to notify an external service about project events but the service is no longer used, this operation can remove that webhook to prevent unnecessary notifications.

Use Case Examples

  1. Deleting a webhook from a GitLab project to stop event notifications to an external service.
  2. Removing a project hook that was created by mistake or is outdated.

Properties

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

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and hook ID are correct and exist in the GitLab instance.
  • Verify that the API authentication credentials have sufficient permissions to delete project hooks.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error: 404 Not Found - The project or hook ID does not exist or is incorrect.
  • Common error: 401 Unauthorized - Authentication failed or missing permissions.

Links

Discussion