GitLab API

GitlabTool
Join our community

Actions1000

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 project's NPM dependencies by leveraging GitLab's security audit API endpoint.

Use Case Examples

  1. A developer wants to ensure their project's NPM packages are secure before deployment by running a quick security audit through GitLab's API.
  2. A DevOps engineer integrates this node in a CI/CD pipeline to automatically trigger security audits on NPM packages for each project update.

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 can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters The path parameter 'id' which is the ID or URL-encoded path of the GitLab project to audit.

Output

JSON

  • auditReport - The JSON response containing the results of the quick security audit on the NPM packages.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to the project ID or URL-encoded path; otherwise, the API call will fail.
  • If authentication is skipped, the request may be unauthorized unless the GitLab instance allows anonymous access.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Common error messages include 401 Unauthorized (check API key and authentication settings) and 404 Not Found (check project ID/path).

Links

Discussion