GitLab API

GitlabTool
Join our community

Actions1000

Overview

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

Use Case Examples

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

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
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 DELETE is relevant for this operation.
Path Parameters Parameters required in the URL path to identify the project, hook, and custom header key to delete.

Output

JSON

  • statusCode - HTTP status code returned by the API indicating the result of the delete operation.
  • responseBody - The body of the response from the API, typically empty for a successful delete operation.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID, 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 GitLab API credential is missing or invalid; verify the API token and permissions.
  • Network or base URL misconfiguration can lead to connection failures; confirm the baseUrl is correct and accessible.

Links

Discussion