GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the Buildkite integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/buildkite`. It is useful for automating the configuration of Buildkite CI/CD integrations within GitLab groups, allowing users to programmatically manage integration settings without manual intervention in the GitLab UI.

Use Case Examples

  1. Automatically update Buildkite integration settings for a GitLab group as part of a CI/CD pipeline setup.
  2. Manage multiple GitLab groups' Buildkite integrations in bulk through an automated workflow.

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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to PUT for this operation.
Parameter Schema Defines the required path parameter `id` and the request body schema for the Buildkite integration update.
Request Body Schema The schema defining the structure of the request body for the Buildkite integration update.
Request Path The API endpoint path for updating the Buildkite integration of a group, with `{id}` as a path parameter.
Path Parameters Collection of path parameters, specifically the `id` of the GitLab group to update the Buildkite integration for.

Output

JSON

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

Dependencies

  • GitLab API authentication credentials

Troubleshooting

  • Ensure the `id` path parameter is correctly set to the target GitLab group ID; an incorrect or missing ID will cause the API request to fail.
  • Verify that the authentication credentials for GitLab API are valid and have sufficient permissions to update group integrations.
  • Check the request body schema matches the expected structure for the Buildkite integration update; malformed or incomplete data may result in API errors.

Links

Discussion