Chief Tools Logo
Domain Chief API v1

Domain Chief API v1

There is no test mode for this API. Registering and transferring domains will result in real-world actions and might incur costs. Use the free .example TLD for testing purposes, these are free to manage.

If you are building an application and want to integrate with Domain Chief, please get in touch to get client credentials and connect users via OAuth2/OpenID for minimal friction.

If you are using a personal access token or a non-team scoped token you can supply the team ID using the X-Chief-Team header with your requests.

Error messages, validation messages, domain notice messages and TLD descriptions are available in English (en) and Dutch (nl). Send an Accept-Language header to choose the language, the Content-Language response header tells which one was used. English is used when none of the requested languages are available. Codes, enum values and field names are never translated, so use those to make decisions in your application. Error responses caused by the state of a resource or a business rule include a code next to the message, see the ErrorCode schema for the possible values. Texts that come directly from a registry and activity descriptions are always in English.

Tags
Security Schemes
ctp
Chief Tools Personal Access Token. Generate a new token from your Chief Tools account.
http
openid
Chief Tools OAuth2 OpenID Connect. This is the preferred way if you are building an application and want to integrate with Domain Chief, please contact us to retrieve your client credentials.
openIdConnect
ctt
Chief Tools Team Access Token. Generate a new token from your Chief Tools team.
http
Webhooks
domain.changed

A domain changed and should be retrieved again.

POST
contact.created

A contact was created.

POST
contact.changed

A contact changed and should be retrieved again.

POST
contact.deleted

A contact was deleted.

POST
dns_record.created

A DNS record was created.

POST
dns_record.changed

A DNS record changed and should be retrieved again.

POST
dns_record.deleted

A DNS record was deleted.

POST
web_redirect.created

A web redirect was created.

POST
web_redirect.changed

A web redirect changed and should be retrieved again.

POST
web_redirect.deleted

A web redirect was deleted.

POST
mail_forward.created

A mail forward was created.

POST
mail_forward.changed

A mail forward changed and should be retrieved again.

POST
mail_forward.deleted

A mail forward was deleted.

POST
domain.registration.requested

A domain registration was requested.

POST
domain.registration.request_cancelled

A pending domain registration was cancelled.

POST
domain.registration.succeeded

A domain was registered.

POST
domain.registration.failed

A domain registration failed.

POST
domain.registration.retry_requested

A failed domain registration is retried.

POST
domain.transfer.incoming.requested

An incoming domain transfer was requested.

POST
domain.transfer.incoming.request_cancelled

A pending incoming transfer was cancelled.

POST
domain.transfer.incoming.succeeded

A domain was transferred in.

POST
domain.transfer.incoming.failed

An incoming domain transfer failed.

POST
domain.transfer.incoming.retry_requested

A failed incoming transfer is retried.

POST
domain.transfer.incoming.scheduled

An incoming transfer was scheduled.

POST
domain.transfer.incoming.schedule_moved

A scheduled incoming transfer was moved.

POST
domain.transfer.incoming.schedule_cancelled

A scheduled incoming transfer was cancelled.

POST
domain.transfer.outgoing.requested

Another registrar requested to transfer a domain out.

POST
domain.transfer.outgoing.succeeded

A domain was transferred to another registrar.

POST
domain.transfer.outgoing.accepted

An outgoing transfer was accepted.

POST
domain.transfer.outgoing.rejected

An outgoing transfer was rejected.

POST
domain.transfer.outgoing.cancelled

An outgoing transfer was cancelled.

POST
domain.transfer.push.requested

A push transfer to another registrar was requested.

POST
domain.transfer.push.failed

A push transfer failed at the registry.

POST
domain.transfer.push.rejected

The receiving registrar rejected a push transfer.

POST
domain.renewal.requested

A manual renewal was requested.

POST
domain.renewal.request_cancelled

An unpaid manual renewal was cancelled.

POST
domain.renewal.failed

A manual renewal was rejected.

POST
domain.renewal.succeeded

A domain was renewed.

POST
domain.payment.received

Payment for a pending domain request was received.

POST
domain.delete.requested

A domain deletion was requested.

POST
domain.delete.failed

A domain deletion failed at the registry.

POST
domain.restorable

A domain was deleted and can still be restored.

POST
domain.deleted

A domain was permanently deleted.

POST
domain.expired

A domain expired.

POST
domain.restore.requested

A domain restore was requested.

POST
domain.restore.request_cancelled

A pending domain restore was cancelled.

POST
domain.restore.succeeded

A domain was restored.

POST
domain.restore.failed

A domain restore failed at the registry.

POST
domain.update.nameservers

A domain's nameservers were updated.

POST
domain.update.nameservers_failed

A nameserver update was rejected.

POST
domain.update.lock_enabled

A domain's transfer lock was enabled.

POST
domain.update.lock_disabled

A domain's transfer lock was disabled.

POST
domain.update.lock_failed

A transfer lock update was rejected.

POST
domain.update.whois_privacy_enabled

A domain's WHOIS privacy was enabled.

POST
domain.update.whois_privacy_disabled

A domain's WHOIS privacy was disabled.

POST
domain.update.whois_privacy_failed

A WHOIS privacy update was rejected.

POST
domain.update.auto_renew_enabled

A domain's auto-renewal was enabled.

POST
domain.update.auto_renew_disabled

A domain's auto-renewal was disabled.

POST
domain.update.auto_renew_failed

An auto-renewal update was rejected.

POST
domain.update.contacts

A domain's contacts were updated.

POST
domain.update.contacts_failed

A contact update was rejected.

POST
domain.update.contacts_and_whois_privacy_failed

A combined contact and WHOIS privacy update was rejected.

POST
domain.update.dnssec_keys

A domain's DNSSEC keys were updated.

POST
domain.update.dnssec_enabled

DNSSEC was enabled for a domain.

POST
domain.update.dnssec_disabled

DNSSEC was disabled for a domain.

POST
domain.update.dnssec_failed

A DNSSEC update was rejected.

POST
domain.update.hosted_dns_enabled

Hosted DNS was enabled for a domain.

POST
domain.update.hosted_dns_disabled

Hosted DNS was disabled for a domain.

POST
domain.update.hosted_dns_sync_failed

Hosted DNS records failed to sync.

POST
domain.update.hosted_dns_restored

Hosted DNS records were restored from DNS history.

POST
domain.update.hosted_dns_staged

Hosted DNS records are prepared before switching nameservers.

POST
domain.update.hosted_dns_staging_cancelled

Preparing hosted DNS was cancelled.

POST
domain.dns.scheduled_change.created

A DNS change was scheduled.

POST
domain.dns.scheduled_change.revised

A scheduled DNS change was revised.

POST
domain.dns.scheduled_change.cancelled

A scheduled DNS change was cancelled.

POST
domain.dns.scheduled_change.applied

A scheduled DNS change was applied.

POST
domain.dns.scheduled_change.conflicted

A scheduled DNS change stopped because records changed.

POST
domain.dns.scheduled_change.superseded

A scheduled DNS change was replaced before it was published.

POST
domain.dns.scheduled_change.publish_failed

A scheduled DNS change could not be published.

POST
domain.mail_forward.renewed

Mail forwarding was renewed.

POST
domain.mail_forward.enabled

Mail forwarding was enabled for a domain.

POST
domain.mail_forward.disabled

Mail forwarding was disabled for a domain.

POST
domain.transfer.internal

A domain moved to another upstream provider, for information only.

POST
domain.contact_verification.required

The registrant of a domain must verify their contact details.

POST
domain.contact_verification.approved

The registrant contact verification was approved.

POST
domain.registry.suspension_scheduled

The registry scheduled a domain for suspension.

POST
domain.registry.suspension_cancelled

The registry cancelled a scheduled suspension.

POST
domain.registry.suspended

The registry suspended a domain.

POST
domain.registry.reinstated

The registry lifted a suspension.

POST
domain.registry.on_hold

The registry placed a domain on hold.

POST
domain.registry.on_hold_removed

The registry removed a hold.

POST
domain.registry.seized

The registry seized a domain.

POST
domain.registry.seizure_removed

The registry lifted a seizure.

POST
domain.imported

An existing domain was imported.

POST
webhook_endpoint.test

A test event sent from the dashboard.

POST