GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to update the Confluence integration settings for a specific project. It is useful for automating the management of project integrations within GitLab, particularly for teams using Confluence for documentation and collaboration. For example, it can be used to programmatically enable or configure Confluence integration for a project based on dynamic workflow conditions.

Use Case Examples

  1. Updating Confluence integration settings for a GitLab project to enable automatic synchronization of documentation.
  2. Automating the configuration of project integrations in GitLab as part of a CI/CD pipeline setup.

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, with PUT being the default for this operation.
Parameter Schema Defines the required path and body parameters for the operation, including the project ID and the Confluence integration settings to update.
Request Body Schema Schema defining the structure of the request body for updating the Confluence integration.
Request Path The API endpoint path for updating the Confluence integration of a project, with a placeholder for the project ID.
Path Parameters Collection of path parameters required for the API call, specifically the project ID.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Confluence integration, typically containing the updated integration details or status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the API key used for authentication has sufficient permissions to update project integrations.
  • Check the request body schema to ensure all required fields for the Confluence integration update are correctly provided.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated requests for this operation, which is uncommon.

Links

Discussion