GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the YouTrack integration settings for a specific GitLab project by sending a PUT request to the GitLab API endpoint `/api/v4/projects/{id}/integrations/youtrack`. It is useful for automating the configuration of YouTrack integrations within GitLab projects, such as enabling or modifying integration parameters programmatically.

Use Case Examples

  1. Automatically update YouTrack integration settings for a project when project details change.
  2. Enable YouTrack integration for multiple projects in bulk via workflow automation.

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 key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but for this operation it is PUT.
Parameter Schema Defines the required path parameter `id` (project ID) and the request body schema for the YouTrack integration update.
Request Body Schema Schema for the request body containing YouTrack integration settings to update.
Request Path The API endpoint path template for the operation, `/api/v4/projects/{id}/integrations/youtrack`.
Path Parameters Collection containing the `id` path parameter representing the project ID to update the integration for.

Output

JSON

  • response - The JSON response from the GitLab API after updating the YouTrack integration, typically containing the updated integration details.

Dependencies

  • Requires GitLab API key authentication credentials to authorize requests to the GitLab API.

Troubleshooting

  • Ensure the provided project ID (`id`) is valid and the authenticated user has permission to update integrations for that project.
  • Verify that the request body conforms to the expected schema for YouTrack integration settings; invalid or missing fields may cause API errors.
  • If authentication is skipped, the request will likely fail due to lack of authorization.
  • Check the base URL if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion