GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows updating the GitGuardian service integration settings for a specific GitLab project by making a PUT request to the GitLab API endpoint `/api/v4/projects/{id}/services/git-guardian`. It is useful for automating the configuration of GitGuardian service on GitLab projects, such as enabling or modifying security scanning features provided by GitGuardian.

Use Case Examples

  1. Automatically update GitGuardian integration settings for a project when a new project is created.
  2. Modify GitGuardian service configuration across multiple projects in bulk.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication to use, default is 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 GET but PUT is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the project ID for this operation.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used has sufficient permissions to update project service integrations.
  • Check the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Common error messages include 401 Unauthorized (invalid or missing API key), 404 Not Found (invalid project ID), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, project ID, or request payload respectively.

Links

Discussion