GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the GitHub integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/github`. It is useful for automating the configuration of GitHub integrations within GitLab groups, such as enabling or modifying webhook URLs, tokens, or other integration parameters.

Use Case Examples

  1. Automatically update GitHub integration settings for a GitLab group when a new project is created.
  2. Modify webhook URLs or tokens for GitHub integration in GitLab groups as part of a CI/CD pipeline setup.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters The path parameters for the API request, specifically the group ID to identify which group's GitHub integration to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the GitHub integration settings for the specified group.

Dependencies

  • Requires GitLab API key credentials for authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used has sufficient permissions to update group integrations.
  • If skipping authentication, the request may fail due to lack of authorization.
  • Check the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.

Links

Discussion