Registrars API
9 REST endpoints for registrars, each with its parameters, the response it returns and a runnable curl example. Starts with GET /api/registrars.
GET/api/registrarssaved connections
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
DELETE/api/registrars/{id}disconnect
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/registrars/{id}/attachAttach a domain and write its DNS after public hosting is ready. Namecheap bare-domain changes require replaceExisting=true; a subdomain such as go.example.com is recommended.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
hostname | body | JSON request field |
zone | body | JSON request field |
replaceExisting | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/registrars/{id}/domainslist the domains inside a connection Domains for one connection. This is the call the dashboard makes straight after an OAuth callback, which is why nothing here asks for a token.
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/registrars/{id}/push/{domainId}Re-push DNS records after public hosting is ready. Existing Namecheap record collisions require an explicit replaceExisting=true after review.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
domainId | path | Required path parameter |
replaceExisting | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/registrars/connectVerify a DNS account before encrypted storage. For provider=namecheap, supply user, apiKey and the allowlisted public outbound clientIp; see /docs/namecheap-domain-setup.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
provider | body | JSON request field |
label | body | JSON request field |
user | body | JSON request field |
apiKey | body | JSON request field |
clientIp | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/registrars/lookuplive DNS check, provider-agnostic
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
hostname | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/registrars/providerswhat we can connect to
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/registrars/recordswhat the records should look like, for the manual path
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
hostname | query | Optional query parameter |
Examples in 22 languages and Try it →