GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a system hook in GitLab by its hook ID. It is useful for managing GitLab system hooks programmatically, such as removing outdated or unwanted hooks to maintain system integrity and security. For example, an administrator can automate the cleanup of system hooks that are no longer needed.

Use Case Examples

  1. Deleting a system hook by specifying its hook ID to stop receiving system event notifications from GitLab.
  2. Automating the removal of system hooks during a cleanup or migration process.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, default is DELETE for this operation.
Path Parameters Collection of path parameters required for the request, specifically the hook_id which identifies the system hook to delete.

Output

JSON

  • statusCode - HTTP status code of the delete operation response.
  • body - Response body from the GitLab API after attempting to delete the system hook.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the hook_id parameter is provided and is a valid integer; otherwise, the API call will fail.
  • Authentication errors may occur if the GitLab API credential is missing or invalid; verify credentials are correctly configured.
  • The baseUrl must point to a valid GitLab instance; incorrect URLs will cause connection failures.
  • If the system hook does not exist or has already been deleted, the API will return an error indicating the hook was not found.

Links

Discussion