GitLab API

GitlabTool

Actions905

Overview

This node operation updates the Squash TM integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/squash-tm`. It is useful for automating the configuration of Squash TM integration within GitLab groups, enabling seamless integration management in CI/CD workflows or group administration tasks.

Use Case Examples

  1. Updating Squash TM integration settings for a GitLab group with ID 12345 to enable or modify integration parameters.
  2. Automating the management of group integrations in GitLab as part of a DevOps pipeline.

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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to PUT for this operation.
Path Parameters The path parameter 'id' specifies the GitLab group ID for which the Squash TM integration is being updated.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Squash TM integration settings.

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 request will fail.
  • Verify that the GitLab API key credential has sufficient permissions to update group integrations.
  • If skipping authentication, the request may fail due to lack of authorization.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the correct API endpoint is targeted.

Links

Discussion