GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific URL variable key from a hook in a GitLab project. It is useful for managing and cleaning up webhook URL variables associated with project hooks in GitLab. For example, if a user wants to remove a particular URL variable from a project's webhook configuration, this operation facilitates that action via the GitLab API.

Use Case Examples

  1. Deleting a URL variable key from a webhook in a GitLab project to update or clean webhook configurations.
  2. Automating the removal of obsolete or incorrect URL variables from project hooks in GitLab.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method used for the API 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 (URL variable key), and id (project identifier).
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 project hook.
Path Parameters Collection of path parameters including hook_id, key, and id required to identify the specific resource to delete.

Output

JSON

  • success - Indicates whether the URL variable key was successfully deleted.
  • statusCode - HTTP status code returned from the API call.
  • responseBody - The response body returned from the GitLab API after the delete operation.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure that the provided project ID (id), hook ID (hook_id), and URL variable key (key) are correct and exist in the GitLab project.
  • Authentication errors may occur if the GitLab API key is missing, invalid, or lacks sufficient permissions to delete hook URL variables.
  • HTTP 404 errors indicate that the specified hook or URL variable key does not exist.
  • HTTP 403 errors indicate insufficient permissions to perform the delete operation on the project hook.

Links

Discussion