GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the External Wiki integration settings for a specific GitLab project using the GitLab API. It is useful for automating the configuration of project integrations, particularly for managing external wiki links associated with projects. For example, a user can update the external wiki URL or related settings for a project by specifying the project ID and the new integration details.

Use Case Examples

  1. Updating the external wiki integration for a GitLab project to point to a new documentation URL.
  2. Automating the setup of external wiki integration for multiple projects in a GitLab instance.

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 to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters Parameters included in the request path, specifically the project ID for this operation.

Output

JSON

  • response - The JSON response from the GitLab API after updating the external wiki integration, containing the updated integration details.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and the project exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update project integrations.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (invalid project ID or integration endpoint), and 400 Bad Request (invalid request body). Resolving these involves verifying credentials, project ID, and request payload format.

Links

Discussion