GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 by providing the necessary configuration in the request body.
  2. Automating the management of Squash TM integration for multiple GitLab groups in an organization.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method HTTP method used for the API request. Defaults to PUT for this operation.
Parameter Schema Defines the path parameter 'id' (integer) required to specify the GitLab group ID for the API request.
Request Body Schema Schema defining the structure of the request body for updating Squash TM integration settings.
Request Path API endpoint path template for the PUT request to update Squash TM integration settings.
Path Parameters Collection of path parameters, specifically the 'id' parameter representing the GitLab group ID.

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 request body conforms to the expected schema for Squash TM integration settings to avoid validation errors from the API.
  • If authentication is skipped or credentials are invalid, the API request will be unauthorized; ensure valid GitLab API credentials are provided.

Links

Discussion