GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a specific domain from the Pages domains of a GitLab project. It is useful for managing and cleaning up project Pages domains by removing domains that are no longer needed or valid. For example, if a project has a custom domain configured for its Pages site and that domain needs to be removed, this operation can be used to delete it via the GitLab API.

Use Case Examples

  1. Deleting a custom domain from a GitLab project's Pages domains to stop serving the site from that domain.
  2. Removing an outdated or incorrect domain from the Pages domains list of a project.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET but DELETE is relevant here.
Path Parameters Parameters for the request path including project ID and domain to delete.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • domain - The domain that was deleted from the project's Pages domains.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID and domain parameters are correctly provided and URL-encoded if necessary.
  • Authentication errors may occur if the API token is missing or invalid; verify credentials.
  • The domain must exist in the project's Pages domains; otherwise, the API may return a not found error.

Links

Discussion