GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation deletes a specific Pages domain from a GitLab project. It is useful for managing GitLab Pages domains associated with projects, particularly when you need to remove outdated or incorrect domain configurations. For example, if a project has a custom domain for its GitLab Pages site that is no longer needed, this operation can be used to delete that domain.

Use Case Examples

  1. Deleting a custom domain from a GitLab Pages project to stop serving the site from that domain.
  2. Removing an incorrectly configured domain from a project's GitLab Pages settings.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically an API key credential.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is DELETE.
Path Parameters Parameters required in the URL path to identify the project and domain to delete.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • domain - The domain name that was deleted.
  • statusCode - The HTTP status code returned by the API indicating success or failure of the delete operation.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and domain are correctly specified and URL-encoded if necessary.
  • Authentication errors may occur if the API key or token is missing or invalid; verify credentials.
  • A 404 error indicates the project or domain does not exist or the user lacks permission.
  • A 403 error indicates insufficient permissions to delete the domain.

Links

Discussion