# All endpoints

> Every endpoint on one page, grouped by section, with its method, path, what it does and a link to its request, response and errors.

Every path is relative to `https://api.domainresellerapi.com` and every request needs the [two authentication headers](https://www.domainnameapi.com/docs/getting-started/authentication/). Select a path to see its request, response and errors.

## Contacts

| Method | Path | What it does |
| --- | --- | --- |
| `POST` | [`/api/v1/contacts`](https://www.domainnameapi.com/docs/contacts/endpoints/#post-apiv1contacts) | Creates a contact and returns its handle code. |
| `GET` | [`/api/v1/contacts/{handleCode}`](https://www.domainnameapi.com/docs/contacts/endpoints/#get-apiv1contactshandlecode) | Reads a contact in your account, together with any verification process currently open on it. |
| `PUT` | [`/api/v1/contacts/{handleCode}`](https://www.domainnameapi.com/docs/contacts/endpoints/#put-apiv1contactshandlecode) | Updates a contact. |
| `GET` | [`/api/v1/contacts/verification/check`](https://www.domainnameapi.com/docs/contacts/verification/#get-apiv1contactsverificationcheck) | Current verification state for a handle. |
| `POST` | [`/api/v1/contacts/verification/request`](https://www.domainnameapi.com/docs/contacts/verification/#post-apiv1contactsverificationrequest) | Re-sends the verification e-mail. |

## Domains

| Method | Path | What it does |
| --- | --- | --- |
| `POST` | [`/api/v1/domains/search`](https://www.domainnameapi.com/docs/domains/availability/#post-apiv1domainssearch) | Is this domain available, and what would it cost? |
| `POST` | [`/api/v1/domains/bulk-search`](https://www.domainnameapi.com/docs/domains/availability/#post-apiv1domainsbulk-search) | Up to **30** domains in one call. |
| `POST` | [`/api/v1/domains/register-with-contacts`](https://www.domainnameapi.com/docs/domains/register/#post-apiv1domainsregister-with-contacts) | Registers a domain, creating contact records from the details you send. |
| `POST` | [`/api/v1/domains/register`](https://www.domainnameapi.com/docs/domains/register/#post-apiv1domainsregister) | Registers a domain using contact handles that already exist in your account. |
| `POST` | [`/api/v1/domains/renew/check`](https://www.domainnameapi.com/docs/domains/renew/#post-apiv1domainsrenewcheck) | Dry run: can this domain be renewed for this term, and at what price? |
| `POST` | [`/api/v1/domains/renew`](https://www.domainnameapi.com/docs/domains/renew/#post-apiv1domainsrenew) | Renews the domain and debits your balance. |
| `POST` | [`/api/v1/domains/transfers/check`](https://www.domainnameapi.com/docs/domains/transfer/#post-apiv1domainstransferscheck) | 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`](https://www.domainnameapi.com/docs/domains/transfer/#post-apiv1domainstransfer) | Starts the transfer and debits your balance. |
| `POST` | [`/api/v1/domains/transfers/query`](https://www.domainnameapi.com/docs/domains/transfer/#post-apiv1domainstransfersquery) | Status of a transfer in flight. |
| `GET` | [`/api/v1/domains/info`](https://www.domainnameapi.com/docs/domains/info/#get-apiv1domainsinfo) | Everything we know about one of your domains. |
| `GET` | [`/api/v1/domains`](https://www.domainnameapi.com/docs/domains/info/#get-apiv1domains) | Paged list of the domains in your account. |
| `POST` | [`/api/v1/domains/lock`](https://www.domainnameapi.com/docs/domains/lock-privacy-auth-code/#post-apiv1domainslock--post-apiv1domainsunlock) | Turns the registrar transfer lock on or off. |
| `POST` | [`/api/v1/domains/unlock`](https://www.domainnameapi.com/docs/domains/lock-privacy-auth-code/#post-apiv1domainslock--post-apiv1domainsunlock) | Turns the registrar transfer lock on or off. |
| `POST` | [`/api/v1/domains/privacy`](https://www.domainnameapi.com/docs/domains/lock-privacy-auth-code/#post-apiv1domainsprivacy) | Turns WHOIS privacy protection on or off. |
| `PUT` | [`/api/v1/domains/auth`](https://www.domainnameapi.com/docs/domains/lock-privacy-auth-code/#put-apiv1domainsauth) | Generates a new transfer authorisation code and returns it. |
| `PUT` | [`/api/v1/domains/contacts/update`](https://www.domainnameapi.com/docs/domains/contacts/#put-apiv1domainscontactsupdate) | Replaces the contact details for one or more roles on a single domain. |
| `PUT` | [`/api/v1/domains/contacts/update-with-handle`](https://www.domainnameapi.com/docs/domains/contacts/#put-apiv1domainscontactsupdate-with-handle) | Points a domain's roles at handles that already exist in your account. |
| `POST` | [`/api/v1/domains/forwards`](https://www.domainnameapi.com/docs/domains/forwarding/#post-apiv1domainsforwards) | Creates a forwarding record. |
| `GET` | [`/api/v1/domains/forwards`](https://www.domainnameapi.com/docs/domains/forwarding/#get-apiv1domainsforwards--delete-apiv1domainsforwards) | Read or remove the forwarding record. |
| `DELETE` | [`/api/v1/domains/forwards`](https://www.domainnameapi.com/docs/domains/forwarding/#get-apiv1domainsforwards--delete-apiv1domainsforwards) | Read or remove the forwarding record. |
| `POST` | [`/api/v1/domains/restore`](https://www.domainnameapi.com/docs/domains/restore/#post-apiv1domainsrestore) | Recovers a deleted domain from the registry's redemption period. |
| `POST` | [`/api/v1/domains/documents`](https://www.domainnameapi.com/docs/domains/documents/#post-apiv1domainsdocuments) | Uploads one or more documents as Base64 and forwards each to the registry. |
| `GET` | [`/api/v1/domains/documents`](https://www.domainnameapi.com/docs/domains/documents/#get-apiv1domainsdocuments) | 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`](https://www.domainnameapi.com/docs/name-servers/#put-apiv1domainsdnsname-server) | Replaces the domain's name servers. |
| `POST` | [`/api/v1/domains/dns/host`](https://www.domainnameapi.com/docs/name-servers/hosts/#post-apiv1domainsdnshost) | Creates a host record with its IP addresses. |
| `PUT` | [`/api/v1/domains/dns/host`](https://www.domainnameapi.com/docs/name-servers/hosts/#put-apiv1domainsdnshost--delete-apiv1domainsdnshost) | Rename a host and/or replace its IP addresses, or delete it. |
| `DELETE` | [`/api/v1/domains/dns/host`](https://www.domainnameapi.com/docs/name-servers/hosts/#put-apiv1domainsdnshost--delete-apiv1domainsdnshost) | Rename a host and/or replace its IP addresses, or delete it. |
| `GET` | [`/api/v1/domains/dns/dnssec`](https://www.domainnameapi.com/docs/name-servers/dnssec/#get-apiv1domainsdnsdnssec) | Current DNSSEC state, the published DS records, and what this extension accepts. |
| `POST` | [`/api/v1/domains/dns/dnssec`](https://www.domainnameapi.com/docs/name-servers/dnssec/#post-apiv1domainsdnsdnssec) | Publishes one or more DS records at the registry, enabling DNSSEC. |
| `DELETE` | [`/api/v1/domains/dns/dnssec`](https://www.domainnameapi.com/docs/name-servers/dnssec/#delete-apiv1domainsdnsdnssec--post-apiv1domainsdnsdnssecdisable) | Remove one DS record, or all of them. |
| `POST` | [`/api/v1/domains/dns/dnssec/disable`](https://www.domainnameapi.com/docs/name-servers/dnssec/#delete-apiv1domainsdnsdnssec--post-apiv1domainsdnsdnssecdisable) | Remove one DS record, or all of them. |

## DNS records

| Method | Path | What it does |
| --- | --- | --- |
| `GET` | [`/api/v1/domains/zones`](https://www.domainnameapi.com/docs/dns-records/endpoints/#get-apiv1domainszones) | Reads every record set in the zone. |
| `POST` | [`/api/v1/domains/zones`](https://www.domainnameapi.com/docs/dns-records/endpoints/#post-apiv1domainszones) | Adds one or more values to a record set. |
| `PUT` | [`/api/v1/domains/zones`](https://www.domainnameapi.com/docs/dns-records/endpoints/#put-apiv1domainszones) | Replaces a record set. |
| `DELETE` | [`/api/v1/domains/zones`](https://www.domainnameapi.com/docs/dns-records/endpoints/#delete-apiv1domainszones) | Deletes **one value** from a record set. |
| `POST` | [`/api/v1/domains/zones/apply`](https://www.domainnameapi.com/docs/dns-records/endpoints/#post-apiv1domainszonesapply) | Publishes the zone by delegating the domain to our name servers. |

## SSL certificates

| Method | Path | What it does |
| --- | --- | --- |
| `POST` | [`/api/v1/ssls/generate-csr`](https://www.domainnameapi.com/docs/ssl/prepare/#post-apiv1sslsgenerate-csr) | Generates a CSR and matching private key on our side. |
| `POST` | [`/api/v1/ssls/check-csr`](https://www.domainnameapi.com/docs/ssl/prepare/#post-apiv1sslscheck-csr) | Decodes a CSR so you can confirm its contents before buying. |
| `GET` | [`/api/v1/ssls/approvers`](https://www.domainnameapi.com/docs/ssl/prepare/#get-apiv1sslsapprovers) | Lists the e-mail addresses the CA will accept as the domain's approver, for e-mail-based validation. |
| `POST` | [`/api/v1/ssls/initialize`](https://www.domainnameapi.com/docs/ssl/buy/#post-apiv1sslsinitialize) |  |
| `PUT` | [`/api/v1/ssls/configure`](https://www.domainnameapi.com/docs/ssl/configure/#put-apiv1sslsconfigure) | Submits everything the CA needs and **opens the order at the provider**. |
| `PUT` | [`/api/v1/ssls/check-status`](https://www.domainnameapi.com/docs/ssl/issue/#put-apiv1sslscheck-status) | Asks the CA where the order stands and updates our record. |
| `GET` | [`/api/v1/ssls/certificate`](https://www.domainnameapi.com/docs/ssl/issue/#get-apiv1sslscertificate) | Full detail for the certificate on a domain. |
| `GET` | [`/api/v1/ssls/certificate-content`](https://www.domainnameapi.com/docs/ssl/issue/#get-apiv1sslscertificate-content) | Returns the issued certificate and its chain. |
| `POST` | [`/api/v1/ssls/reissue`](https://www.domainnameapi.com/docs/ssl/reissue-revoke-renew/#post-apiv1sslsreissue) | Re-issues an active certificate with a new key pair or a new approver. |
| `DELETE` | [`/api/v1/ssls/revoke`](https://www.domainnameapi.com/docs/ssl/reissue-revoke-renew/#delete-apiv1sslsrevoke) | Revokes the certificate. |

## Hosting

| Method | Path | What it does |
| --- | --- | --- |
| `GET` | [`/api/v1/hostings/packages`](https://www.domainnameapi.com/docs/hosting/#get-apiv1hostingspackages) | Lists what you can sell. |
| `POST` | [`/api/v1/hostings/create`](https://www.domainnameapi.com/docs/hosting/#post-apiv1hostingscreate) | Buys the package and queues provisioning. |
| `GET` | [`/api/v1/hostings/check-status`](https://www.domainnameapi.com/docs/hosting/#get-apiv1hostingscheck-status) | Reports where provisioning got to and, once complete, returns the credentials. |
| `GET` | [`/api/v1/hostings`](https://www.domainnameapi.com/docs/hosting/#get-apiv1hostings--get-apiv1hostingsby-token--get-apiv1hostingsplans) | Look up a hosting record, or read its plan limits. |
| `GET` | [`/api/v1/hostings/by-token`](https://www.domainnameapi.com/docs/hosting/#get-apiv1hostings--get-apiv1hostingsby-token--get-apiv1hostingsplans) | Look up a hosting record, or read its plan limits. |
| `GET` | [`/api/v1/hostings/plans`](https://www.domainnameapi.com/docs/hosting/#get-apiv1hostings--get-apiv1hostingsby-token--get-apiv1hostingsplans) | Look up a hosting record, or read its plan limits. |

## Catalogue & billing

| Method | Path | What it does |
| --- | --- | --- |
| `GET` | [`/api/v1/products/tlds`](https://www.domainnameapi.com/docs/catalogue/#get-apiv1productstlds) |  |
| `GET` | [`/api/v1/products/ssls`](https://www.domainnameapi.com/docs/catalogue/ssl/#get-apiv1productsssls) | Certificate packages and their prices. |
| `GET` | [`/api/v1/products/info`](https://www.domainnameapi.com/docs/catalogue/ssl/#get-apiv1productsinfo) | One product with its selling price recalculated for your account right now. |
| `GET` | [`/api/v1/order/{orderCode}`](https://www.domainnameapi.com/docs/catalogue/orders/#get-apiv1orderordercode) | Reads one order with its line items. |
| `GET` | [`/api/v1/deposit/accounts/me`](https://www.domainnameapi.com/docs/catalogue/balance/#get-apiv1depositaccountsme) | Your current balances. |
| `GET` | [`/api/v1/deposit/transactions`](https://www.domainnameapi.com/docs/catalogue/balance/#get-apiv1deposittransactions) | Paged ledger of every balance movement. |