GitLab API

GitlabTool
Join our community

Actions1000

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 for group repositories.

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 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 GET but set to PUT for this operation.
Path Parameters Parameters to specify the group ID in the API path.

Output

JSON

  • id - The ID of the GitLab group for which the integration is updated.
  • integrationStatus - The status or result of the GitGuardian integration update operation.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID path parameter is correctly provided and is a valid integer to avoid path errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to update group integrations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If skipping authentication, confirm that the API endpoint allows unauthenticated requests, otherwise the request will fail.

Links

Discussion