GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API, specifically supporting the operation to quickly audit npm package security vulnerabilities via a POST request to the endpoint `/api/v4/packages/npm/-/npm/v1/security/audits/quick`. It is useful for developers and DevOps teams who want to automate security checks on npm packages used in their projects, ensuring vulnerabilities are identified promptly.

Use Case Examples

  1. Automatically trigger a security audit on npm packages after a new package version is published.
  2. Integrate npm package security auditing into CI/CD pipelines to prevent deployment of vulnerable dependencies.

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 for the API request, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to POST for this operation.
Parameter Schema Hidden property representing the schema for parameters of the POST request, used internally for validation or UI generation.
Request Body Schema Hidden property representing the schema for the request body of the POST request, used internally for validation or UI generation.
Request Path The API endpoint path for the quick security audit of npm packages, fixed to `/api/v4/packages/npm/-/npm/v1/security/audits/quick`.

Output

JSON

  • response - The JSON response from the GitLab API containing the results of the npm package security audit.

Dependencies

  • Requires GitLab API key credentials for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access the npm package security audit endpoint.
  • Verify the baseUrl is correct and accessible from the network where the node is running.
  • If the API returns authentication errors, check if Skip Authentication is mistakenly enabled or if the API key has expired or been revoked.
  • For HTTP method errors, confirm that the method is set to POST as required by this operation.

Links

Discussion