GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation deletes a custom header from a specific hook of a project in GitLab via the GitLab API. It is useful for managing webhook configurations by removing custom headers that are no longer needed or were added incorrectly. For example, if a user wants to clean up webhook headers for a project hook, this operation allows them to delete a specified custom header by providing the project ID, hook ID, and the header key.

Use Case Examples

  1. Deleting a custom header from a project hook to update webhook settings.
  2. Removing an obsolete or incorrect custom header from a GitLab project hook.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL for the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but DELETE is used for this operation.
Parameter Schema Defines the required path parameters for the API call: hook_id (hook identifier), key (custom header key), and id (project identifier).
Request Body Schema No request body is required for this delete operation.
Request Path API endpoint path template for deleting the custom header from the project hook.
Path Parameters Collection of path parameters including hook_id, key, and id to specify the exact resource to delete.

Output

JSON

  • response - The API response confirming the deletion of the custom header.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure that the project ID, hook ID, and custom header key are correctly specified; incorrect values will cause the API call to fail.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify credentials are correctly configured.
  • Network or permission issues might prevent successful deletion; check network connectivity and user permissions on GitLab.

Links

Discussion