GitLab API

GitlabTool
Join our community

Actions1000

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, 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 stop sending that variable with webhook requests.
  2. Managing project hooks by removing outdated or unnecessary URL variables.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, typically a GitLab API key.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters required in the request path to identify the project, hook, and URL variable key to delete.

Output

JSON

  • statusCode - HTTP status code of the response indicating success or failure of the delete operation.
  • responseBody - The body of the response from the GitLab API after attempting to delete the URL variable key.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the provided project ID, hook ID, and URL variable key are correct and exist in the GitLab project.
  • Verify that the authentication credentials have sufficient permissions to delete hook URL variables.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project, hook, or key does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion