GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs an HTTP PUT request to update the Unify Circuit integration settings for a specific GitLab group. It is useful for automating the management of group integrations within GitLab, particularly for teams using Unify Circuit as a communication tool. For example, it can be used to enable or configure the Unify Circuit integration for a group programmatically.

Use Case Examples

  1. Updating the Unify Circuit integration settings for a GitLab group by specifying the group ID and the desired configuration in the request body.
  2. Automating integration updates as part of a CI/CD pipeline to ensure consistent communication tool settings across multiple groups.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API authentication. Hidden unless Skip Authentication is false.
baseUrl The base URL for the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to PUT.
Path Parameters The path parameters for the request, specifically the group ID to identify which group's integration to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Unify Circuit integration for the specified group.

Dependencies

  • Requires GitLab API authentication credentials to authorize the request.

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and the authenticated user has permission to update integrations for that group.
  • Verify that the request body schema matches the expected structure for the Unify Circuit integration update to avoid validation errors.
  • Check network connectivity and the base URL to ensure the GitLab instance is reachable.

Links

Discussion