GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation deletes the Pages of a specified project in GitLab using the GitLab API. It is useful for automating the removal of project pages, for example, when cleaning up or decommissioning projects. The operation requires the project ID or URL-encoded path to identify which project's pages to delete.

Use Case Examples

  1. Deleting the Pages of a project by providing the project ID to automate cleanup tasks.
  2. Removing Pages from a project as part of a CI/CD pipeline after deployment.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public endpoints or testing.
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 HTTP method to use for the request, default is GET but DELETE is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the project ID or URL-encoded path to identify the project.

Output

JSON

  • statusCode - HTTP status code returned by the API after attempting to delete the project pages.
  • responseBody - The body of the response from the API, typically empty or containing confirmation of deletion.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided; otherwise, the API will return an error indicating the project was not found.
  • If authentication is skipped, the request may fail if the GitLab instance requires authentication for deleting project pages.
  • Check that the baseUrl is correct and accessible; incorrect URLs will cause connection errors.
  • Common error messages include 404 Not Found if the project does not exist or 403 Forbidden if the user lacks permission to delete pages. Ensure the API key has sufficient permissions.

Links

Discussion