GitLab API icon

GitLab API

Gitlab

Actions880

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-specific domains associated with GitLab Pages, especially when a domain is no longer needed or should be removed for security or organizational reasons. For example, a user can delete a custom domain linked to their project's GitLab Pages site.

Use Case Examples

  1. Deleting a custom domain from a GitLab project's Pages domains to prevent it from serving content.
  2. Removing an outdated or compromised domain from a project's Pages configuration.

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 Parameters required in the request path to identify the project and domain to delete.

Output

JSON

  • statusCode - HTTP status code of the delete operation response.
  • responseBody - Response body returned from the delete operation, typically empty or confirmation message.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and domain parameters are correctly specified and URL-encoded if necessary.
  • Verify that the authentication credentials are valid and have sufficient permissions to delete project Pages domains.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project or domain does not exist, and 403 Forbidden if the user lacks permission to delete the domain.

Links

Discussion