All endpoints

Every path is relative to https://api.domainresellerapi.com and every request needs the two authentication headers. Select a path to see its request, response and errors.

Contacts

Method	Path	What it does
POST	/api/v1/contacts	Creates a contact and returns its handle code.
GET	/api/v1/contacts/{handleCode}	Reads a contact in your account, together with any verification process currently open on it.
PUT	/api/v1/contacts/{handleCode}	Updates a contact.
GET	/api/v1/contacts/verification/check	Current verification state for a handle.
POST	/api/v1/contacts/verification/request	Re-sends the verification e-mail.

Domains

Method	Path	What it does
POST	/api/v1/domains/search	Is this domain available, and what would it cost?
POST	/api/v1/domains/bulk-search	Up to 30 domains in one call.
POST	/api/v1/domains/register-with-contacts	Registers a domain, creating contact records from the details you send.
POST	/api/v1/domains/register	Registers a domain using contact handles that already exist in your account.
POST	/api/v1/domains/renew/check	Dry run: can this domain be renewed for this term, and at what price?
POST	/api/v1/domains/renew	Renews the domain and debits your balance.
POST	/api/v1/domains/transfers/check	Asks the registry whether the domain can be transferred to you with the authorisation code you hold, and what it would cost.
POST	/api/v1/domains/transfer	Starts the transfer and debits your balance.
POST	/api/v1/domains/transfers/query	Status of a transfer in flight.
GET	/api/v1/domains/info	Everything we know about one of your domains.
GET	/api/v1/domains	Paged list of the domains in your account.
POST	/api/v1/domains/lock	Turns the registrar transfer lock on or off.
POST	/api/v1/domains/unlock	Turns the registrar transfer lock on or off.
POST	/api/v1/domains/privacy	Turns WHOIS privacy protection on or off.
PUT	/api/v1/domains/auth	Generates a new transfer authorisation code and returns it.
PUT	/api/v1/domains/contacts/update	Replaces the contact details for one or more roles on a single domain.
PUT	/api/v1/domains/contacts/update-with-handle	Points a domain's roles at handles that already exist in your account.
POST	/api/v1/domains/forwards	Creates a forwarding record.
GET	/api/v1/domains/forwards	Read or remove the forwarding record.
DELETE	/api/v1/domains/forwards	Read or remove the forwarding record.
POST	/api/v1/domains/restore	Recovers a deleted domain from the registry's redemption period.
POST	/api/v1/domains/documents	Uploads one or more documents as Base64 and forwards each to the registry.
GET	/api/v1/domains/documents	Lists the documents uploaded for a domain and their review status.

Name servers & DNSSEC

Method	Path	What it does
PUT	/api/v1/domains/dns/name-server	Replaces the domain's name servers.
POST	/api/v1/domains/dns/host	Creates a host record with its IP addresses.
PUT	/api/v1/domains/dns/host	Rename a host and/or replace its IP addresses, or delete it.
DELETE	/api/v1/domains/dns/host	Rename a host and/or replace its IP addresses, or delete it.
GET	/api/v1/domains/dns/dnssec	Current DNSSEC state, the published DS records, and what this extension accepts.
POST	/api/v1/domains/dns/dnssec	Publishes one or more DS records at the registry, enabling DNSSEC.
DELETE	/api/v1/domains/dns/dnssec	Remove one DS record, or all of them.
POST	/api/v1/domains/dns/dnssec/disable	Remove one DS record, or all of them.

DNS records

Method	Path	What it does
GET	/api/v1/domains/zones	Reads every record set in the zone.
POST	/api/v1/domains/zones	Adds one or more values to a record set.
PUT	/api/v1/domains/zones	Replaces a record set.
DELETE	/api/v1/domains/zones	Deletes one value from a record set.
POST	/api/v1/domains/zones/apply	Publishes the zone by delegating the domain to our name servers.

SSL certificates

Method	Path	What it does
POST	/api/v1/ssls/generate-csr	Generates a CSR and matching private key on our side.
POST	/api/v1/ssls/check-csr	Decodes a CSR so you can confirm its contents before buying.
GET	/api/v1/ssls/approvers	Lists the e-mail addresses the CA will accept as the domain's approver, for e-mail-based validation.
POST	/api/v1/ssls/initialize
PUT	/api/v1/ssls/configure	Submits everything the CA needs and opens the order at the provider.
PUT	/api/v1/ssls/check-status	Asks the CA where the order stands and updates our record.
GET	/api/v1/ssls/certificate	Full detail for the certificate on a domain.
GET	/api/v1/ssls/certificate-content	Returns the issued certificate and its chain.
POST	/api/v1/ssls/reissue	Re-issues an active certificate with a new key pair or a new approver.
DELETE	/api/v1/ssls/revoke	Revokes the certificate.

Hosting

Method	Path	What it does
GET	/api/v1/hostings/packages	Lists what you can sell.
POST	/api/v1/hostings/create	Buys the package and queues provisioning.
GET	/api/v1/hostings/check-status	Reports where provisioning got to and, once complete, returns the credentials.
GET	/api/v1/hostings	Look up a hosting record, or read its plan limits.
GET	/api/v1/hostings/by-token	Look up a hosting record, or read its plan limits.
GET	/api/v1/hostings/plans	Look up a hosting record, or read its plan limits.

Catalogue & billing

Method	Path	What it does
GET	/api/v1/products/tlds
GET	/api/v1/products/ssls	Certificate packages and their prices.
GET	/api/v1/products/info	One product with its selling price recalculated for your account right now.
GET	/api/v1/order/{orderCode}	Reads one order with its line items.
GET	/api/v1/deposit/accounts/me	Your current balances.
GET	/api/v1/deposit/transactions	Paged ledger of every balance movement.