mittwald API icon

mittwald API

Interact with the mittwald API

Actions125

Domain → Create Scheduled Deletion

AI-generated

Summary

Schedule deletion of a domain by specifying its ID and the desired deletion date, with an option to also delete associated ingress and subdomain ingress records.

Inputs

  • Domain ID (required) — The unique identifier of the domain to schedule for deletion.
  • Deletion Date (required) — The target ISO-8601 date and time when the domain should be deleted.
  • Delete Ingresses — Boolean flag indicating whether to also delete the ingress and related subdomain ingresses associated with the domain.

Output shape

a single JSON object representing the scheduled deletion details for the domain.

The output confirms the scheduled deletion including the domain ID, deletion date, and ingress deletion status. Errors are thrown if required inputs are missing or invalid.

Examples

Example 1: Schedule domain deletion with ingress deletion

Set the Domain ID to "12345", Deletion Date to "2024-12-31T23:59:59Z", and Delete Ingresses to true.

Links

Discussion