GitLab API icon

GitLab API

Gitlab

Actions917

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 old or unused project sites. 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 project pages as part of a CI/CD pipeline after project archival.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is 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

  • success - Indicates if the deletion of the project pages was successful.
  • statusCode - HTTP status code returned by the API after the delete request.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct and accessible by the authenticated user.
  • Check that the GitLab API key has sufficient permissions to delete project pages.
  • Verify the base URL is correct if using a self-hosted GitLab instance.
  • Common error: 404 Not Found - The project ID does not exist or the user lacks access.
  • Common error: 401 Unauthorized - Authentication failed or API key is invalid.

Links

Discussion