GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific URL variable key from a GitLab hook identified by its hook ID. It is useful for managing and cleaning up URL variables associated with GitLab hooks, especially when certain variables are no longer needed or need to be removed for security or configuration reasons. For example, if a webhook has outdated or incorrect URL variables, this operation can remove them to ensure the hook functions correctly.

Use Case Examples

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

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of 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 operation: hook_id (ID of the hook) and key (key of the URL variable).
Request Body Schema No request body is required for this DELETE operation.
Request Path API endpoint path template for deleting the URL variable key from the hook.
Path Parameters Collection of path parameters including hook_id (the hook's ID) and key (the URL variable key to delete).

Output

JSON

  • statusCode - HTTP status code of the delete operation response.
  • responseBody - Response body returned from the GitLab API after deleting the URL variable key.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the hook_id and key parameters are correctly provided and valid; otherwise, the API will return an error indicating the resource was not found.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions to delete hook URL variables.
  • Network or baseUrl misconfiguration can cause connection failures; verify the baseUrl is correct and accessible.

Links

Discussion