GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation deletes a custom header from a specific hook in GitLab using 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 the headers sent with webhook requests, 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 'X-Custom-Header' from a webhook with ID 12345 to stop sending that header in webhook requests.
  2. Removing an obsolete authentication header from a GitLab hook to update security settings.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to DELETE for this operation.
Path Parameters Parameters 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 returned from the GitLab API after deleting the custom header

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the hook ID and custom header key are correctly specified; incorrect values will cause the API to return errors such as 404 Not Found.
  • Authentication errors may occur if the API token is missing or invalid; verify the credentials are correctly configured.
  • Network or base URL issues can cause connection failures; confirm the baseUrl is correct and accessible.

Links

Discussion