GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs a quick security audit on npm packages within a specified GitLab project. It is useful for developers and DevOps teams who want to quickly check for vulnerabilities in their npm dependencies directly from their GitLab projects. For example, it can be used to automate security checks in CI/CD pipelines to ensure package safety before deployment.

Use Case Examples

  1. A developer triggers this node to scan npm packages in a project to identify known security issues.
  2. A DevOps engineer integrates this node in a workflow to automatically audit npm dependencies after each commit.

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, default is GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters to be included in the request path, specifically the project ID or URL-encoded path required for the API call.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • Verify that the GitLab API key has sufficient permissions to perform security audits on the project.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages may include authentication failures, invalid project ID, or permission denied errors. Resolving these typically involves verifying credentials, project access rights, and correct API endpoint usage.

Links

Discussion