GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation deletes a specific URL variable key from a hook associated with a project in GitLab. It is useful for managing and cleaning up webhook URL variables in GitLab projects, especially when certain variables are no longer needed or need to be removed for security or configuration reasons. For example, if a webhook URL variable was set incorrectly or is outdated, this operation can remove it without affecting other hook settings.

Use Case Examples

  1. Deleting a URL variable key from a project hook to update webhook configurations.
  2. Removing sensitive or deprecated URL variables from a GitLab project hook to enhance security.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, which is DELETE for this operation.
Path Parameters Parameters required in the URL path to identify the project, hook, and variable key to delete.

Output

JSON

  • success - Indicates whether the URL variable key was successfully deleted.
  • statusCode - HTTP status code returned by the API after the delete operation.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure that the project ID, hook ID, and variable key are correctly specified; incorrect values will cause the API to fail.
  • Authentication errors may occur if the API key or token is invalid or missing; verify credentials are correctly configured.
  • Permission errors may arise if the authenticated user does not have sufficient rights to modify the project hooks.
  • Network or base URL misconfiguration can lead to connection failures; confirm the baseUrl is correct for the GitLab instance.

Links

Discussion