GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a specific URL variable key for a project hook in GitLab via the GitLab API. It is useful for managing and modifying webhook URL variables dynamically within GitLab projects, such as changing webhook URLs or parameters without manually accessing the GitLab interface.

Use Case Examples

  1. Updating a webhook URL variable key for a project hook to change the callback URL for CI/CD triggers.
  2. Modifying a specific URL variable key to update authentication tokens or parameters used by the webhook.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
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, default is GET but PUT is used for this operation.
Parameter Schema Defines the path parameters and request body schema for the operation, including project ID, hook ID, and variable key.
Request Body Schema Schema for the request body to update the URL variable key.
Request Path API endpoint path for the operation, with placeholders for project ID, hook ID, and variable key.
Path Parameters Collection of path parameters required for the API call: hook_id, key, and id (project ID).

Output

JSON

  • response - The JSON response from the GitLab API after updating the URL variable key for the project hook.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the provided project ID, hook ID, and variable key are correct and exist in GitLab to avoid 404 errors.
  • Verify that the API key used has sufficient permissions to update project hooks and URL variables.
  • Check the request body schema matches the expected format to prevent validation errors from the API.

Links

Discussion