get_deployment
Check deployment progress and DNS state for each domain, then act on per-domain actions such as adding records, pushing to Cloudflare, or registering the domain.
Instructions
Get the status of a deployment and the per-domain DNS state. Poll this for progress. Statuses: CREATED → PENDING → IN_PROGRESS → WAITING → COMPLETED (or FAILED).
Response fields you should always read:
status— pipeline state.dns— per-domain DNS state, populated once Terraform emits a state snapshot. Present regardless ofstatus; check it on every poll, not just on WAITING.requiredAction— legacy; only set whenstatus=WAITINGand there are records to add. Preferdns.
For each entry in dns, read action and behave as follows:
NO_ACTION— registrar NS already delegate to a zone Staticbot owns; nothing to ask the user. Celebrate.MANUAL_RECORDS_AT_REGISTRAR— presentrecords(cert CNAME + ALIAS/CNAME for the website) to the user, asking them to add them at whatever DNS provider currently serves their domain. Do NOT suggest changing nameservers — Staticbot intentionally does not recommend NS takeover as a default path.OFFER_CLOUDFLARE_PUSH— domain is on Cloudflare and an integration is linked. Offer push_dns_to_cloudflare using this item's exactdomainId; obtain authorization before the external DNS write. Manual records at the current provider remain the fallback.OFFER_CLOUDFLARE_CONNECT— domain is on Cloudflare without an integration. Suggest connecting Cloudflare (direct the user to the integrations page) for the smoothest no-NS-change path.REGISTER_DOMAIN_FIRST— domain is not registered. Block and ask the user to register it first.
Other fields per domain:
staticbotManaged— true when live registrar NS overlap our recorded Route53 zone NS for this apex. Useful for explaining 'your domain is already pointing at us'.nsPointedAt—AWS_ROUTE53|CLOUDFLARE|OTHER(where the live NS resolve to).mailRecordsDetected— true when MX/TXT/SRV/CAA records exist on the apex. Treat as a hard block on any advice that involves changing nameservers — doing so would risk breaking the customer's mail.cloudflareLinked— true when the domain is wired to a Cloudflare integration in Staticbot.domainId— Staticbot DNS-domain ID; pass this exact value to push_dns_to_cloudflare.records— flat list of{type, host, value, description}to surface to the user.
The response also includes failureSummary when a worker job is failing or has been retried. Surface its summary; when terminal=true, include the statusUrl so the user can inspect the full failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Deployment ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Parsed JSON response from the Staticbot public API |