GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation deletes a custom header from a specific hook in the GitLab API (version 4). 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 project, this operation allows them to delete a particular custom header by specifying the hook ID and the header key.

Use Case Examples

  1. Deleting a custom header from a webhook hook to stop sending unnecessary information.
  2. Removing an outdated authentication header from a GitLab webhook.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, hidden unless Skip Authentication is false.
baseUrl The base URL for the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method for the request, default is GET but DELETE is used for this operation.
Path Parameters Parameters for the request path, including hook_id (the ID of the hook) and key (the key of the custom header to delete).

Output

JSON

  • statusCode - HTTP status code of the delete operation response
  • body - Response body from the GitLab API after deleting the custom header

Dependencies

  • GitLab API authentication (API key or token)

Troubleshooting

  • Ensure the hook_id and key parameters are correctly specified and exist in GitLab; otherwise, the API will return an error.
  • Authentication errors may occur if the API token is missing or invalid; verify credentials are correctly configured.
  • Network or baseUrl misconfiguration can cause connection failures; confirm the baseUrl is correct for the GitLab instance.

Links

Discussion