GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates the external wiki integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/external-wiki`. It is useful for managing and configuring external wiki integrations within GitLab groups programmatically, such as enabling or modifying wiki integration details for collaboration purposes.

Use Case Examples

  1. Updating the external wiki integration for a GitLab group to change the wiki URL or enable/disable the integration.
  2. Automating the configuration of external wiki settings for multiple GitLab groups in an organization.

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.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to PUT for this operation.
Path Parameters The path parameters for the API request, specifically the group ID (`id`) to identify which group's external wiki integration to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the external wiki integration.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID (`id`) path parameter is correctly provided and corresponds to an existing GitLab group.
  • Verify that the API key credential has sufficient permissions to update group integrations.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid group ID or endpoint), and 400 Bad Request (invalid request body). Resolving these involves verifying credentials, parameters, and request payloads.

Links

Discussion