GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes the Pages of a specified project in GitLab using the GitLab API. It is useful for scenarios where you want to programmatically remove the Pages associated with a project, for example, when cleaning up project resources or managing project deployments.

Use Case Examples

  1. Deleting the Pages of a project by specifying the project ID or URL-encoded path.
  2. Automating the removal of project Pages as part of a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, 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 DELETE for this operation.
Path Parameters The path parameters for the request, specifically the project ID or URL-encoded path to identify the project whose Pages are to be deleted.

Output

JSON

  • statusCode - The HTTP status code returned by the API after attempting to delete the project Pages.
  • responseBody - The body of the response from the API, which may contain confirmation or error details.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters; otherwise, the API call will fail.
  • If authentication is required and skipped, the request will be unauthorized; ensure proper authentication is configured unless skipping is intentional.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 404 Not Found if the project does not exist or 403 Forbidden if the user lacks permission to delete the Pages. Verify project existence and user permissions.

Links

Discussion