GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates the GitHub integration settings for a specific GitLab group by making 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 settings 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 enable/disable integration features for GitHub within a GitLab group programmatically.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
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 PUT for this operation.
Path Parameters The path parameters for the API request, specifically the group ID (`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 for the specified group.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID (`id`) path parameter is correctly set and corresponds to an existing GitLab group.
  • Verify that the GitLab API key credential has sufficient permissions to update group integrations.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests for this endpoint, otherwise the request will fail.
  • Common error messages include 401 Unauthorized (invalid or missing API key), 404 Not Found (group ID does not exist), and 400 Bad Request (invalid request body). Verify request parameters and authentication to resolve these.

Links

Discussion