GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 should be removed for security or configuration reasons. For example, a user can delete a URL variable from a project hook to update webhook settings without manually accessing the GitLab interface.

Use Case Examples

  1. Deleting a URL variable key from a project hook to remove outdated or sensitive information.
  2. Automating the cleanup of webhook URL variables across multiple GitLab projects.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but can be set to DELETE for this operation.
Path Parameters The path parameters required for the API call, including the project ID, hook ID, and the key of the URL variable to delete.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure that the provided project ID, hook ID, and key are correct and exist in the GitLab project to avoid 404 Not Found errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to delete hook URL variables to prevent authorization errors.
  • Check the base URL if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion