GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating the external wiki service configuration for a specific project in GitLab via the GitLab API. It is useful for automating the management of project integrations, specifically modifying the external wiki service settings for a project identified by its ID. For example, it can be used to programmatically update the external wiki URL or enable/disable the service for a project.

Use Case Examples

  1. Updating the external wiki service settings for a GitLab project to change the wiki URL.
  2. Enabling or disabling the external wiki integration for a specific project via automation.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters The path parameters for the API request, specifically the project ID to identify which project's external wiki service to update.

Output

JSON

  • id - The ID of the project whose external wiki service was updated.
  • service_status - The status or result of the external wiki service update operation.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update project services.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, invalid project ID, or insufficient permissions. Resolving these typically involves verifying credentials, project existence, and user permissions.

Links

Discussion