Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/plutoploy/dns-handling/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to inspect the current state of a domain at any point in its lifecycle — from initial registration through to an active TLS certificate. The response includes the domain’s status, creation timestamp, and, once ownership has been verified, the exact time verification occurred. Poll this endpoint to track progress after triggering verification or certificate issuance.

​
Method and Path

GET /domains/{id}

​
Path Parameters

​
id
string
required
The unique domain identifier returned by POST /domains at registration time. This is a 32-character hex string derived from 16 random bytes.

​
Response — 200 OK

​
id
string
The unique identifier for this domain record, matching the {id} path parameter.
​
domain_name
string
The fully-qualified domain name that was registered, e.g. example.com.
​
status
string
The current lifecycle status of the domain. One of:
  • pending — registered but ownership not yet confirmed
  • verified — TXT record check passed; domain ownership is proven
  • certificate_pending — a TLS certificate order has been placed with the ACME provider and is being processed
  • active — a valid TLS certificate has been issued and stored
  • failed — certificate issuance failed (e.g. ACME polling timed out)
​
verified_at
string
RFC3339 timestamp recording when domain ownership was successfully verified. This field is omitted when status is pending and is present for all statuses at or beyond verified.
​
created_at
string
RFC3339 timestamp recording when the domain was first registered with POST /domains.

​
Examples

​
Pending Domain

curl http://localhost:8080/domains/3f2a1b4c5d6e7f8a9b0c1d2e3f4a5b6c

{
  "id": "3f2a1b4c5d6e7f8a9b0c1d2e3f4a5b6c",
  "domain_name": "example.com",
  "status": "pending",
  "created_at": "2024-06-01T10:00:00Z"
}

​
Active Domain

curl http://localhost:8080/domains/3f2a1b4c5d6e7f8a9b0c1d2e3f4a5b6c

{
  "id": "3f2a1b4c5d6e7f8a9b0c1d2e3f4a5b6c",
  "domain_name": "example.com",
  "status": "active",
  "verified_at": "2024-06-01T10:15:32Z",
  "created_at": "2024-06-01T10:00:00Z"
}

​
Error Cases

StatusCause
404 Not FoundNo domain record exists for the supplied {id}.

Build docs developers (and LLMs) love

Get started for freeTalk to us