GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a custom header from a specific hook in GitLab via the GitLab API. It is useful for managing webhook configurations by removing unwanted or outdated custom headers from hooks. For example, if a user wants to clean up or update webhook headers for a particular hook, this operation allows them to delete a specified custom header by its key.

Use Case Examples

  1. Deleting a custom header from a webhook hook to stop sending unnecessary header data.
  2. Removing an outdated authentication header from a GitLab hook to update security settings.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request, defaulting to DELETE for this operation.
Path Parameters Parameters used in the API request path to specify the hook ID and the key of the custom header to delete.

Output

JSON

  • statusCode - HTTP status code of the delete operation response.
  • responseBody - Response body from the API after attempting to delete the custom header.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the hook_id and key parameters are correctly set and correspond to existing resources in GitLab.
  • Authentication errors may occur if the API token is missing, invalid, or lacks sufficient permissions to modify hooks.
  • A 404 error indicates the specified hook or custom header key does not exist.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the API endpoint is correct.

Links

Discussion