GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the Squash TM integration settings for a specific GitLab project using the GitLab API. It is useful for automating the configuration of Squash TM integration in GitLab projects, enabling seamless integration management within workflows. For example, it can be used to enable or modify Squash TM integration settings for a project identified by its ID.

Use Case Examples

  1. Updating Squash TM integration settings for a project with a given ID to enable or configure the integration automatically.
  2. Automating project integration management in CI/CD pipelines by updating Squash TM settings programmatically.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used 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.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters The path parameters for the API request, specifically the project ID to identify which project's Squash TM integration to update.

Output

JSON

  • id - The ID of the project for which the Squash TM integration was updated.
  • integration_status - The status of the Squash TM integration after the update.
  • updated_fields - Details of the fields that were updated in the Squash TM integration settings.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to update project integrations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If authentication is skipped, ensure the API endpoint allows unauthenticated requests, otherwise the request will fail.

Links

Discussion