Our API in one page: what you can automate in your account, area by area

The short answer: the API lets your own program do much of what you do by hand in My MozOut: register domains, change DNS, create mailboxes, restart a VPS, pay invoices from your credit balance or open a support ticket. It is a REST API, it answers in JSON, it works over HTTPS only, and every request carries a key that you create on the API page in My MozOut.

The essentials at a glance

What	How it works
Base address	https://api.mozout.com/v1
Format	JSON over HTTPS. Field names are in English.
Authentication	A key in the Authorization: Bearer ... header, never in the address.
Two modes	Sandbox (sandbox_): reads real data and simulates changes. Production (prod_): reads and changes the account.
Languages	Error messages come in Portuguese or English, following the Accept-Language header. Without it, they come in English.
Who can use it	The owner of an account with an active service or domain. Up to 20 keys per account.

What it does, area by area

Area	Examples of what it does
Domains	Check a name, register, renew, transfer, change nameservers, transfer lock and auto-renewal.
DNS	Read the zone, add, change and delete records, restore a zone backup.
Hosting	Plan usage, subdomains, addon domains, databases, cron, SSL, PHP options, backups and FTP.
E-mail	Mailboxes, passwords, quotas, forwarders, autoresponders, the default address and the status of SPF, DKIM and DMARC.
VPS servers	See the state, start, stop, restart, root password, backups, reinstall and restore.
SMS	Send messages and check the balance, history and templates.
Invoices	List, download the PDF, pay with credit, change the renewal cycle and request a cancellation.
Account	Read the account details, contacts and users.
Catalogue	Products, domain extensions, currencies and billing cycles, with prices.
Support	Open, reply to and close tickets, read the Knowledge Base and announcements.
Extras	See SSL certificates, SiteLock and other extras, and buy some of them with credit.
Reseller	See your reseller programs and reseller hosting accounts.

Anything not in the API does not exist there yet: you do it in My MozOut. The API grows in phases, and the documentation says, for each area, what exists today and what is planned.

Who it is for

1	Resellers and agencies: register domains, change DNS and create mailboxes for their clients without opening My MozOut. See the API for resellers.

2	Business systems and websites: check and pay invoices with credit, open support tickets or send SMS to customers.

3	Server automation: scripts that start, restart or reinstall a VPS and keep nameservers and DNS up to date.

How to start

1	Test the connection. GET /v1/ping answers without a key, which makes it the best first test.

2	Create a Sandbox key on the API page, with only the permissions you need. The walkthrough is in creating an API key.

3	Make your first request with the key: GET /v1/token shows the mode, permissions, validity and limits of the key.

4	Once your program is ready, create a Production key. The address and the operations stay the same: see Sandbox or Production.

curl https://api.mozout.com/v1/ping
curl https://api.mozout.com/v1/token -H "Authorization: Bearer $RLX_API_KEY"

A successful answer always carries data and meta; an error carries error, with a code that never changes. Every answer has an X-Correlation-ID header: keep it, because it is what support needs to find the request. If APIs are new to you, start with what an API is, in plain words.

Want to connect your programs to your account? The API page has the summary, the documentation with examples and the button to create your first key.

See the API page

Categories

Categories