GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

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

Use Case Examples

  1. Updating Confluence integration settings for a GitLab group with ID 12345 to enable or change integration options.
  2. Automating the configuration of Confluence integration across 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 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, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET but set to PUT for this operation.
Path Parameters The path parameter 'id' specifies the GitLab group ID for which the Confluence integration is being updated.

Output

JSON

  • id - The ID of the GitLab group for which the integration was updated.
  • integrationStatus - The status or result of the Confluence integration update operation.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid GitLab group ID to avoid 404 errors.
  • Verify that the API key credential has sufficient permissions to update group integrations.
  • Check the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, otherwise the request will fail with authentication errors.

Links

Discussion