GitLab API

GitlabTool

Actions905

Overview

This node operation updates the TeamCity integration settings for a specific GitLab group using the GitLab API. It is useful for automating the configuration of TeamCity CI/CD integration within GitLab groups, allowing users to programmatically manage integration settings without manual intervention. For example, it can be used in workflows that synchronize CI/CD configurations across multiple GitLab groups or update integration settings as part of a deployment pipeline.

Use Case Examples

  1. Updating TeamCity integration settings for a GitLab group identified by its ID.
  2. Automating the configuration of CI/CD integrations in GitLab groups.

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 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.
Parameter Schema Defines the required path parameter 'id' and the request body schema for the TeamCity integration update.
Request Body Schema The schema defining the structure of the request body for updating the TeamCity integration.
Request Path The API endpoint path for updating the TeamCity integration of a group, with a placeholder for the group ID.
Path Parameters Collection of path parameters, specifically the 'id' of the GitLab group to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the TeamCity integration.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid GitLab group ID; otherwise, the API request will fail.
  • Verify that the authentication credentials are valid and have sufficient permissions to update group integrations.
  • Check the request body schema to ensure it matches the expected format for the TeamCity integration update; invalid schema may cause API errors.

Links

Discussion