GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the TeamCity integration settings for a specific GitLab project using the GitLab API. It is useful for automating the configuration of TeamCity CI/CD integration within GitLab projects, allowing users to programmatically manage integration settings without manual intervention. For example, a DevOps engineer can use this node to update TeamCity integration parameters across multiple projects in a batch process.

Use Case Examples

  1. Updating TeamCity integration settings for a GitLab project by specifying the project ID and providing the integration configuration in the request body.
  2. Automating the enabling or disabling of TeamCity integration for projects as part of a CI/CD pipeline setup.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request. Hidden and defaults to GitLab API key authentication.
baseUrl The base URL of the GitLab instance. Defaults to https://gitlab.com.
Method The HTTP method used for the request. Options include GET, POST, PUT, DELETE, HEAD, PATCH. Defaults to GET.
Parameter Schema Defines the path and body parameters for the operation. Includes the project ID (path parameter) and the TeamCity integration settings (body parameter). Hidden from the user interface.
Request Body Schema Schema for the request body containing TeamCity integration settings. Hidden from the user interface.
Request Path The API endpoint path for updating TeamCity integration settings, with a placeholder for the project ID. Hidden from the user interface.
Path Parameters Collection of path parameters required for the request. Includes the project ID as a string.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and the project exists in GitLab.
  • Verify that the API key used for authentication has sufficient permissions to update project integrations.
  • Check the request body schema to ensure all required TeamCity integration fields are correctly provided.
  • If authentication is skipped, the request may fail due to lack of authorization.

Links

Discussion