GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 should be removed for security or configuration reasons. For example, if a user wants to remove an outdated or incorrect URL variable from a webhook, this operation facilitates that action via the GitLab API.

Use Case Examples

  1. Deleting a URL variable key from a GitLab hook to update webhook 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, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET but DELETE is used for this operation.
Parameter Schema Schema defining required path parameters for the operation: hook_id (hook identifier) and key (URL variable key).
Request Body Schema Schema for the request body, which is null 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 ID of the hook) and key (the key of the URL variable to delete).

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the hook_id and key path 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 GitLab API key credential is missing or invalid; verify the credential configuration.
  • Network or baseUrl misconfiguration can cause connection failures; confirm the baseUrl is correct and accessible.

Links

Discussion