Track async operations (bulk domain renew, set nameservers, get auth codes). Each bulk request creates a task; poll /tasks/{id} for progress, or subscribe to the task.completed webhook to avoid polling.
Task types: domain.renew, domain.set_nameservers, domain.get_auth_info.
Lifecycle: PENDING → RUNNING → COMPLETED | PARTIAL | FAILED. PARTIAL means some items succeeded and some failed — inspect result[].ok to tell them apart.
See GET /tasks/{id} for the full response schema, per-task-type payload shapes, and example responses for each status.
List tasks
Returns a paginated list of your async tasks, sorted newest-first. Each row has the same shape as GET /tasks/{id} (including full payload and result), so you can render dashboards without a second round-trip. Use type and status to filter.
query Parameters
limitoffsettypeFilter by task type: domain.renew, domain.set_nameservers, or domain.get_auth_info.
statusFilter by lifecycle status. PARTIAL = some items succeeded and some failed.
List tasks › Responses
List of tasks
successGet task by ID
Fetch a specific async task with its full payload, per-item results, progress counters, and timestamps. Poll this endpoint to track the state of bulk operations created via POST /domains/renew, POST /domains/set-nameservers, or POST /domains/get-auth-info.
Task types
type | Source | Payload shape | Per-item result.data shape |
|---|---|---|---|
domain.renew | POST /domains/renew | { items: [{ domainId, term }] } | { term, newExpiry } |
domain.set_nameservers | POST /domains/set-nameservers | { items: [{ domainId, nameservers }] } | { nameservers } |
domain.get_auth_info | POST /domains/get-auth-info | { items: [{ domainId }] } | { authInfo, recipient } |
Status lifecycle
Code
PENDING— the task has been created and is waiting in the queue.startedAtisnull.RUNNING— the worker is processing items one-by-one.completedandfailedcounters update incrementally so you can show a liveX/Yprogress bar.COMPLETED— every item succeeded (failed === 0).PARTIAL— some items succeeded and some failed (completed > 0 && failed > 0).FAILED— every item failed, or the task hit a fatal error (see top-levelerrorfield).
done is a convenience boolean that flips to true once the task reaches any terminal status (COMPLETED, PARTIAL, or FAILED).
Results array
result is an array with one entry per input item, in the same order. Each entry has:
domainId— the originaldomainIdfrom the payload.domain— the fully-qualified domain name (populated once the worker has loaded the domain row).ok—trueif this item succeeded,falseotherwise.data— type-specific success payload (see table above). Present only whenok === true.error— error message. Present only whenok === false.
The result array is updated incrementally as items finish, so polling mid-run gives you partial results immediately.
Polling or webhooks?
For low-latency UX, subscribe to the task.completed webhook instead of polling — Most POSTs the full task payload to your webhook URL when the task reaches a terminal state.
path Parameters
idGet task by ID › Responses
Task details
success