Skip to main content
GET
/
api
/
public
/
v1
/
domains
/
{domain_id}
/
progress
Get domain setup progress
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/domains/{domain_id}/progress \
  --header 'X-API-Key: <api-key>'
{
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_name": "<string>",
  "current_step": "<string>",
  "overall_status": "<string>",
  "progress_percentage": 123,
  "steps": [
    {
      "step_name": "<string>",
      "step_order": 123,
      "status": "<string>",
      "message": "<string>",
      "details": {},
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_error": "<string>",
  "estimated_completion": "2023-11-07T05:31:56Z",
  "can_retry": false,
  "retry_count": 0,
  "last_retry_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

​
domain_id
string<uuid>
required

Query Parameters

Response

Progress retrieved successfully

Domain setup progress response.

​
domain_id
string<uuid>
required

Domain ID

​
domain_name
string
required

Domain name

​
current_step
string
required

Current step being processed

​
overall_status
string
required

Overall setup status

​
progress_percentage
integer
required

Progress percentage (0-100)

​
steps
DomainProgressStep · object[]
required

Detailed step progress

​
created_at
string<date-time>
required

Setup start time

​
updated_at
string<date-time>
required

Last update time

​
last_error
string | null

Last error if any

​
estimated_completion
string<date-time> | null

Estimated completion time

​
can_retry
boolean
default:false

Whether setup can be retried

​
retry_count
integer
default:0

Number of retry attempts

​
last_retry_at
string<date-time> | null

Last retry timestamp

​
failure_reason
string | null

Detailed failure reason