Registrar

registrar

Registrar

Domains

registrar.domains

Methods

Get Domain -> Envelope<unknown>
get/accounts/{account_id}/registrar/domains/{domain_name}

Show individual domain.

List Domains -> SinglePage<>
get/accounts/{account_id}/registrar/domains

List domains handled by Registrar.

Update Domain -> Envelope<unknown>
put/accounts/{account_id}/registrar/domains/{domain_name}

Update individual domain.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

path Parameters
account_id: string
(maxLength: 32)

Identifier

domain_name: string

Domain name.

Body parameters
auto_renew: boolean
Optional

Auto-renew controls whether subscription is automatically renewed upon domain expiration.

locked: boolean
Optional

Shows whether a registrar lock is in place for a domain.

privacy: boolean
Optional

Privacy option controls redacting WHOIS information.

Response fields
errors: Array<>
messages: Array<>
result: unknown
success: true

Whether the API call was successful

Request example
200Example

Domain types

Domain = { id, available, can_register, 9 more... }