GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the GitGuardian integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/git-guardian`. It is useful for automating the configuration of GitGuardian integration within GitLab groups, such as enabling or modifying security scanning features provided by GitGuardian.

Use Case Examples

  1. Automatically update GitGuardian integration settings for a GitLab group as part of a CI/CD pipeline.
  2. Manage security integrations across multiple GitLab groups programmatically.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using 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.
Path Parameters The path parameter 'id' specifies the GitLab group ID for which the GitGuardian integration is being updated.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid GitLab group ID; otherwise, the API will return an error.
  • Authentication errors may occur if the GitLab API credential is missing or invalid; verify the credential configuration.
  • The baseUrl should point to a valid GitLab instance; incorrect URLs will cause connection failures.
  • The request body must conform to the expected schema for GitGuardian integration settings; invalid data will result in API errors.

Links

Discussion