Skip to main content
GET
Get domain setup progress

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

domain_id
string<uuid>
required

Response

Progress retrieved successfully

Simple domain setup progress response for customers.

This schema hides ALL internal implementation details - no stages, no step names, no retry counts, no technical failure reasons. Just simple status information.

success
boolean
required
message
string
required
domain_id
string<uuid>
required

Domain ID

domain_name
string
required

Domain name

status
string
required

Current status: PENDING, IN_PROGRESS, COMPLETED, or FAILED

progress_percentage
integer
required

Overall progress (0-100)

is_complete
boolean
required

Whether setup is complete

is_failed
boolean
required

Whether setup has failed

status_message
string | null

User-friendly status message