GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating the GitGuardian service integration settings for a specific project in GitLab via the GitLab API. 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 parameters for multiple projects in bulk via workflow automation.

Properties

Name Meaning
Skip Authentication Option to skip using authentication for the API request.
Authentication Type of authentication to use for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET but can be set to PUT 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 for the specified project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication 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 (authentication failure), 404 Not Found (invalid project ID or service endpoint), and 400 Bad Request (invalid request body or parameters).

Links

Discussion