Our API documentation: what it is, who it is for and how to find it

The short answer: the API documentation is the site where we explain, page by page, how to connect your own programs to your MozOut account: your website, your billing system, an app or a simple script. It has guides, a reference for every operation, code examples ready to copy and a Playground to try requests in your browser. Anyone can read it, with no account and no sign-in: open the documentation.

Who it is for

Who	What they find there
Developers and agencies	The API rules, the reference for each operation, examples in curl, PHP, Python and JavaScript, and the OpenAPI specification to import into their tools.
Business owners	The "What the API does today" list on the home page, so you know what can be automated before asking a developer for a quote.
Technical teams already using the API	The page for each area, the error codes, the limits and the operations that show the state of a key.
AI tools	A Markdown version of every page and a plain-text index, the llms.txt file.

What it is, and what it is not

The documentation is about the API: requests, responses, keys and permissions. To use your services through My MozOut, such as creating a mailbox, paying an invoice or changing nameservers by hand, the right place is this Knowledge Base. The two are linked: at the end of every documentation page there is a "Did not find what you were looking for?" box that leads to the search and to the Knowledge Base.

What is on the home page

1	First steps: check that the API responds, create a key in My MozOut, and make your first request with that key.

2	Start here: cards for Get started with the API, Authentication and keys, Permissions, API rules, the reference and the Playground.

3	What the API does today: the list of operations in this version. The API is growing in stages, and the page says so plainly: anything not on the list does not exist in the API yet, and those tasks are done in My MozOut.

4	API areas: domains, DNS, hosting, email, servers, SMS, Email Center, invoices and credit, account, catalog, support, extra products, reseller, and key and status.

How to get there

1	From the website: the API page has a button that opens the documentation.

2	Directly: this link takes you to the home page; bookmark it.

3	From the Knowledge Base: articles about the API, like this one, link to the right documentation pages.

From the documentation, the top menu takes you back to the website, the Knowledge Base and My MozOut. The documentation exists in Portuguese and English: see where each language lives.

Reading the documentation is free; using the API needs a key. To create keys you need a MozOut account with an active service or domain. Keys are created in My MozOut, on the API page, never in the documentation.

Not a developer? Read the home page and the "What the API does today" list, then pass the right links to whoever will do the programming: see how to hand the documentation to a developer or agency.

Want to see what the API can already do with your account? The documentation is open to everyone.

Open the documentation

Categories

Categories