GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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. Automate updating 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 key 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 here it is PUT for this operation.
Path Parameters Parameters to specify the path variables in the API endpoint, specifically the group ID here.

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 key credential for authentication

Troubleshooting

  • Ensure the group ID path parameter is correctly provided and valid; otherwise, the API will return an error.
  • Verify that the authentication credentials are valid and have sufficient permissions to update group integrations.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 401 Unauthorized (invalid or missing credentials), 404 Not Found (invalid group ID), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, verifying group ID, and ensuring the request body matches the expected schema.

Links

Discussion