GitLab API

GitlabTool
Join our community

Actions1000

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 settings for collaboration and documentation purposes.

Use Case Examples

  1. Updating the external wiki integration settings for a GitLab group with ID 123 to enable or change the wiki URL or other parameters.
  2. Automating the configuration of external wiki integrations across multiple GitLab groups in an organization.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the request. For this operation, it is PUT by default but can be changed.
Path Parameters The path parameters for the API request, specifically the group ID (`id`) which is required to identify the GitLab group whose external wiki integration is being updated.

Output

JSON

  • id - The ID of the GitLab group whose external wiki integration was updated.
  • external_wiki_url - The URL of the external wiki configured for the group.
  • external_wiki_active - Boolean indicating if the external wiki integration is active.
  • updated_at - Timestamp of when the integration was last updated.

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.
  • 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).

Links

Discussion