GitLab API

GitlabTool
Join our community

Actions1000

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, 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 request, defaulting 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

  • statusCode - HTTP status code returned by the API after the update request.
  • responseBody - The JSON response body containing the updated Confluence integration details or error information.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid GitLab group ID; otherwise, the API will return an error.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to update group integrations.
  • If 'Skip Authentication' is set to true, the request may fail due to lack of authentication.
  • Check the request body schema to ensure all required fields for the Confluence integration update are correctly provided.

Links

Discussion