GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation performs a housekeeping task on a specific project in GitLab by sending a POST request to the endpoint `/api/v4/projects/{id}/housekeeping`. It is useful for maintaining and optimizing the project's repository by cleaning up unnecessary data. Typical use cases include automating repository maintenance tasks within CI/CD pipelines or project management workflows.

Use Case Examples

  1. Automate repository housekeeping for a project with ID 123 to optimize storage and performance.
  2. Trigger housekeeping on multiple projects periodically to keep repositories clean and efficient.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the 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 request is sent.
Method The HTTP method used for the request, default is POST for this operation.
Path Parameters Parameters included in the request path, specifically the project ID to identify the target project for housekeeping.

Output

JSON

  • statusCode - HTTP status code of the housekeeping request response.
  • responseBody - The body of the response returned from the GitLab API after performing housekeeping.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the GitLab API base URL is correct and reachable.
  • Check that the API key used for authentication has sufficient permissions to perform housekeeping on the project.
  • Common error messages include 404 Not Found if the project ID is invalid or inaccessible, and 401 Unauthorized if authentication fails.

Links

Discussion