GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates the External Wiki integration settings for a specific project in GitLab using the PUT method on the endpoint `/api/v4/projects/{id}/integrations/external-wiki`. It is useful for automating the configuration of external wiki integrations in GitLab projects, such as enabling or modifying wiki integration details programmatically.

Use Case Examples

  1. Automatically update the external wiki integration for a project when project settings change.
  2. Integrate with a CI/CD pipeline to ensure wiki integration settings are consistent across multiple projects.

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 authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request, default is PUT for this operation.
Path Parameters The path parameters for the API request, specifically the project ID (`id`) to identify which project's external wiki integration to update.

Output

JSON

  • id - The ID of the project whose external wiki integration was updated.
  • external_wiki_url - The URL of the external wiki set in the integration.
  • external_wiki_slug - The slug identifier for the external wiki.
  • external_wiki_title - The title of the external wiki.
  • external_wiki_authentication - Authentication details for accessing the external wiki, if applicable.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID (`id`) path parameter is correctly provided and corresponds to an existing project in GitLab.
  • Verify that the authentication token has sufficient permissions to update project integrations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If skipping authentication, confirm that the API endpoint allows unauthenticated requests, which is uncommon for this operation.

Links

Discussion