Skip to content
Proud to collaborate with Microsoft for Startups

spad.domain-deletion ​

Removes a custom domain configuration from a SPAD site

Removes a custom domain configuration from a SPAD site.

Input fields: domain_id, site_id, organization_id

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-spad
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
domain_uuidstringYes—SpadDomain UUID to remove
site_uuidstringYes—SpadSite UUID the domain belongs to
organization_uuidstringNo—Organization UUID that owns the site; inferred from the domain when omitted

Output Schema ​

FieldTypeRequiredDefaultDescription
domain_uuidstringYes—SpadDomain UUID that was removed
site_uuidstringYes—Site UUID the domain belonged to
organization_uuidstringYes—Organization UUID that owns the site
domain_namestringYes—The custom domain name
certificate_arnstringNo—ACM certificate ARN snapshotted from the domain
dns_record_refstringNo—DNS record id snapshotted from the domain (provider-native)
dns_connection_uuidstringNo—DNS CloudConnection UUID snapshotted from the domain
dns_zone_uuidstringNo—DnsZone UUID snapshotted from the domain
cloudfront_distribution_refstringNo—CloudFront distribution id the domain was attached to (provider-native)
cloud_connection_uuidstringNo—AWS CloudConnection UUID used for ACM/CloudFront
alias_removedstringNo—True when the CloudFront alias was removed; 'skipped' when not applicable
certificate_deletedstringNo—True when the ACM certificate was deleted; 'skipped' when not applicable
dns_deletedstringNo—True when the DNS record was deleted; 'skipped' when not applicable
resources_deletedlistYes—Accumulated list of resource tags that were deleted
initiated_atstringYes—ISO8601 timestamp when the workflow was initiated
completed_atstringNo—ISO8601 timestamp when the workflow reached COMPLETED
failed_atstringNo—ISO8601 timestamp when the workflow reached FAILED
failure_reasonstringNo—Reason recorded on the failure path
errorstringNo—Engine-stamped failure metadata
error_typestringNo—Engine-stamped failure metadata
failed_at_statejsonNo—Engine-stamped failure metadata
failed_layerjsonNo—Engine-stamped failure metadata
failed_stepjsonNo—Engine-stamped failure metadata

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—remove_cloudfront_alias—
deleting_certificateNoNo—delete_dns_record—
deleting_dnsNoNo—complete—
removing_aliasNoNo—delete_certificate—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedremove_cloudfront_aliasremoving_alias—
removing_aliasdelete_certificatedeleting_certificate—
deleting_certificatedelete_dns_recorddeleting_dns—
deleting_dnscompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "spad.domain-deletion",
  "initial_data": {
    "domain_uuid": "value",
    "site_uuid": "value"
  }
}