Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
The short answer: for resellers and anyone managing client websites, the API handles what is in your account: domains, DNS, hosting, mailboxes, invoices and support tickets. With reseller:read you also see your reseller programs and reseller hosting accounts. What the API does not do is touch the accounts your clients have inside your reseller plan.
What the reseller area shows
| Operation | What it returns |
| GET /v1/reseller | Which reseller programs the account has: domains, SMS and hosting, with the status of each. |
| GET /v1/reseller/services | Reseller hosting accounts, in pages. |
| GET /v1/reseller/services/{id} | One of them. Access details never come through the API: you see them in My MozOut, at manage_url. |
These operations only read, and only show what belongs to this account.
What the API does not cover
| Your own clients: the API neither shows nor changes them. Accounts created inside a reseller hosting account are managed in that account's panel (WHM), not through our API. Write access for the reseller area (reseller:write) has no operations yet. |
An agency's working day, through the API
| Task | Operation | Permission |
| Check whether the client's name is free, and the price | GET /v1/domains/availability | domains:read |
| Register the domain, paid from credit | POST /v1/domains/register | domains:write and billing:purchase |
| Point DNS at the client's site | POST /v1/domains/{domain}/dns | dns:write |
| Add the domain to one of your hosting plans | POST /v1/services/{id}/addon-domains | hosting:write |
| Create the client's mailboxes | POST /v1/services/{id}/email/mailboxes | email:write |
| Request the free SSL certificate | POST /v1/services/{id}/ssl/autossl | hosting:write |
| Renew the domain every year | POST /v1/domains/{domain}/renew | domains:write and billing:purchase |
The details of each step are in the article for each area: domains, DNS, hosting and e-mail.
The account, contacts and users
With account:read, GET /v1/account returns the name, company, e-mail, address, currency and status of the account, but never passwords or card details. GET /v1/account/contacts and GET /v1/account/users return the contacts and the people with access (the owner first, with owner set to true). Changing the account and contacts is still done in My MozOut.
| Organise keys by task, not by client: one purchasing key with a spending limit, another for DNS and e-mail with no sensitive permissions, another read-only for reports. Reseller domain prices come from the price catalogue, and reseller hosting is on the reseller page. |
|
Reselling domains or hosting? See the API page and automate the repetitive work for your clients. See the API page |
RECOMMENDED PRODUCT Reseller hosting with WHM Create, host and bill your own plans, under your own brand. from $35.57/mo (3-year plan, with coupon) See plans |
