GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to perform 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 the security status of npm packages used in their projects hosted on GitLab. For example, it can be used to automate security checks in CI/CD pipelines to ensure dependencies are safe before deployment.

Use Case Examples

  1. Perform a quick security audit on npm packages for a project with a given project ID to identify vulnerabilities.
  2. Integrate with GitLab to automate security audits of npm dependencies as part of a continuous integration workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET but can be POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Schema defining the path parameter 'id' which is the ID or URL-encoded path of the GitLab project.
Request Body Schema Schema for the request body, if applicable for the operation.
Request Path API endpoint path for the quick security audit of npm packages in a project.
Path Parameters Collection of path parameters including 'id' which specifies the project ID or URL-encoded path.

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 credential is valid and has sufficient permissions to access the project and perform security audits.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • 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 parameter values.

Links

Discussion