GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to perform a housekeeping operation on a specific project. It is useful for automating maintenance tasks on GitLab projects, such as cleaning up repository data to optimize storage and performance. For example, a user can trigger this node to run housekeeping on a project identified by its ID or URL-encoded path.

Use Case Examples

  1. Automate repository housekeeping for a project to reduce storage usage.
  2. Schedule regular maintenance tasks on GitLab projects to keep them optimized.

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 to which the API request is sent.
Method The HTTP method used for the API request, defaulting to POST for this operation.
Path Parameters Parameters included in the API request path, specifically the project ID or URL-encoded path to identify the project for housekeeping.

Output

JSON

  • response - The JSON response from the GitLab API after performing the housekeeping operation on the specified project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters to avoid 404 errors.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to perform housekeeping on the project.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion