GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the GitHub integration settings for a specific project in GitLab via the GitLab API. It is useful for automating the configuration of GitHub integrations within GitLab projects, such as enabling or modifying webhook URLs, tokens, or other integration parameters. For example, a DevOps engineer can use this node to programmatically update GitHub integration settings across multiple projects without manual intervention.

Use Case Examples

  1. Updating the GitHub integration webhook URL for a project.
  2. Enabling or disabling GitHub integration features for a specific GitLab project.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Parameter Schema Defines the required path and body parameters for the operation, including the project ID and the GitHub integration settings to update.
Request Body Schema Schema defining the structure of the request body for updating the GitHub integration.
Request Path The API endpoint path template for updating the GitHub integration of a project.
Path Parameters Collection of path parameters, specifically the project ID to identify which project's GitHub integration to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the GitHub integration, typically containing the updated integration details or status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the GitLab API key credential has sufficient permissions to update project integrations.
  • Check the request body schema to ensure all required fields for the GitHub integration update are correctly provided.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated requests for this operation, which is uncommon.

Links

Discussion