GitLab API

GitlabTool

Actions905

Overview

This node operation performs an HTTP PUT request to update the Bamboo integration settings for a specific GitLab project. It is useful for automating the configuration of Bamboo CI/CD integration within GitLab projects, allowing users to programmatically manage project integrations without manual intervention. For example, it can be used in workflows that synchronize project settings or update integration parameters based on external triggers.

Use Case Examples

  1. Updating Bamboo 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 Bamboo integration for multiple projects in a batch process.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is PUT.
Parameter Schema Schema defining the path parameter 'id' (project ID) and the request body for the Bamboo integration update.
Request Body Schema Schema for the request body payload to update Bamboo integration settings.
Request Path API endpoint path template for the PUT request to update Bamboo integration for a project.
Path Parameters Collection of path parameters, specifically the 'id' of the project to update.

Output

JSON

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

Dependencies

  • Requires GitLab API key credential for authentication.

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and accessible with the authenticated user.
  • Verify that the request body conforms to the expected schema for Bamboo integration settings to avoid validation errors.
  • Check network connectivity and base URL correctness if the API request fails to reach the GitLab server.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions.

Links

Discussion