# MozOut: API documentation

> Guides and reference for the MozOut API. Base address: https://api.mozout.com/v1. Every page has a Markdown version, listed below.

## Documentação em português

- [Início](https://docs.mozout.com/pt/index.md): Guias e referência da API da MozOut, para ligar os seus programas à sua conta.
- [Começar com a API](https://docs.mozout.com/pt/getting-started.md): Do primeiro pedido à primeira chave, em poucos minutos.
- [Autenticação e chaves](https://docs.mozout.com/pt/authentication.md): Como criar uma chave, usá-la nos pedidos e mantê-la segura.
- [Permissões](https://docs.mozout.com/pt/permissions.md): O que cada chave pode fazer, por área, e as permissões que ficam separadas.
- [Regras da API](https://docs.mozout.com/pt/api-rules.md): As regras que valem em todas as operações: erros, limites, paginação, repetições e os modos Sandbox e Produção.
- [Domínios](https://docs.mozout.com/pt/domains.md): Consultar, registar, renovar e transferir domínios, e gerir nameservers, bloqueio e renovação automática pela API.
- [DNS](https://docs.mozout.com/pt/dns.md): Ler e alterar as zonas DNS dos seus domínios pela API, com cópia antes de cada alteração.
- [Hospedagem](https://docs.mozout.com/pt/hosting.md): Ver os serviços da conta e gerir uma hospedagem pela API: uso, domínios, bases de dados, cron, SSL, PHP, cópias e FTP.
- [E-mail](https://docs.mozout.com/pt/email.md): Gerir as caixas de e-mail de uma hospedagem pela API: senhas, quotas, reencaminhadores, respostas automáticas, conta geral, SPF, DKIM e DMARC.
- [Servidores](https://docs.mozout.com/pt/servers.md): Ver o estado, ligar, desligar, reiniciar, mudar a senha e reinstalar os seus servidores VPS pela API.
- [SMS](https://docs.mozout.com/pt/sms.md): Envie SMS pela API e veja o histórico, as estatísticas, o saldo, os modelos, os remetentes e os números que não recebem.
- [Email Center](https://docs.mozout.com/pt/email-center.md): Envie e-mails da sua aplicação pela API, com domínios verificados, modelos, registo de cada entrega, lista de bloqueados, estatísticas e webhooks.
- [Facturas e saldo](https://docs.mozout.com/pt/billing.md): Consultar e pagar facturas com saldo, ver encomendas e cotações, mudar o ciclo de renovação e pedir um cancelamento pela API.
- [Conta e segurança](https://docs.mozout.com/pt/account.md): Ver os dados da conta, os contactos e os utilizadores pela API.
- [Catálogo](https://docs.mozout.com/pt/catalog.md): Ver os produtos, as extensões de domínio, as moedas e os ciclos de pagamento pela API.
- [Suporte](https://docs.mozout.com/pt/support.md): Abrir, responder e fechar tickets, e ler os artigos da Base de Conhecimento e os anúncios pela API.
- [Produtos extra](https://docs.mozout.com/pt/extras.md): Veja os certificados, o SiteLock, a rádio e outros extras da conta, consulte o catálogo e compre com saldo pela API.
- [Revenda](https://docs.mozout.com/pt/reseller.md): Veja os programas de revenda da conta e as contas de revenda de hospedagem pela API.
- [Chave e estado](https://docs.mozout.com/pt/key-status.md): Confirmar que a API responde, ver o que a chave pode fazer, acompanhar operações longas e descarregar a especificação.
- [Todas as operações](https://docs.mozout.com/pt/reference.md): Todas as operações da API, com filtro, a ligar à página de cada área.
- [Visão geral](https://docs.mozout.com/pt/playground.md): Escolha uma operação, preencha o pedido e veja a resposta da API, com o código pronto em curl, PHP, Python e JavaScript.

## Documentation in English

- [Home](https://docs.mozout.com/index.md): Guides and reference for the MozOut API, so your programs can work with your account.
- [Get started with the API](https://docs.mozout.com/getting-started.md): From your first request to your first key, in a few minutes.
- [Authentication and keys](https://docs.mozout.com/authentication.md): How to create a key, use it in requests and keep it safe.
- [Permissions](https://docs.mozout.com/permissions.md): What each key can do, by area, and the permissions that stay separate.
- [API rules](https://docs.mozout.com/api-rules.md): The rules that apply to every operation: errors, limits, pagination, retries and the Sandbox and Production modes.
- [Domains](https://docs.mozout.com/domains.md): Check, register, renew and transfer domains, and manage nameservers, the lock and auto-renewal through the API.
- [DNS](https://docs.mozout.com/dns.md): Read and change the DNS zones of your domains through the API, with a copy before each change.
- [Hosting](https://docs.mozout.com/hosting.md): See the services of the account and manage a hosting account through the API: usage, domains, databases, cron, SSL, PHP, backups and FTP.
- [Email](https://docs.mozout.com/email.md): Manage the mailboxes of a hosting account through the API: passwords, quotas, forwarders, autoresponders, default address, SPF, DKIM and DMARC.
- [Servers](https://docs.mozout.com/servers.md): See the state, start, stop, restart, change the password and reinstall your VPS servers through the API.
- [SMS](https://docs.mozout.com/sms.md): Send SMS through the API and see the history, statistics, balance, templates, senders and numbers that do not receive.
- [Email Center](https://docs.mozout.com/email-center.md): Send email from your application through the API, with verified domains, templates, a log of every delivery, a suppression list, statistics and webhooks.
- [Invoices and credit](https://docs.mozout.com/billing.md): See invoices and pay them with credit, see orders and quotes, change the renewal cycle and request a cancellation through the API.
- [Account and security](https://docs.mozout.com/account.md): See the account details, contacts and users through the API.
- [Catalog](https://docs.mozout.com/catalog.md): See the products, domain extensions, currencies and billing cycles through the API.
- [Support](https://docs.mozout.com/support.md): Open, reply to and close tickets, and read Knowledge Base articles and announcements through the API.
- [Extra products](https://docs.mozout.com/extras.md): See the certificates, SiteLock, radio and other extras of the account, look at the catalog and buy with credit through the API.
- [Reseller](https://docs.mozout.com/reseller.md): See the reseller programs of the account and the reseller hosting accounts through the API.
- [Key and status](https://docs.mozout.com/key-status.md): Confirm that the API answers, see what the key can do, follow long operations and download the specification.
- [All operations](https://docs.mozout.com/reference.md): Every API operation, with a filter, linking to the page of each area.
- [Overview](https://docs.mozout.com/playground.md): Choose an operation, fill in the request and see the API response, with the code ready in curl, PHP, Python and JavaScript.

## Specification

- [OpenAPI](https://docs.mozout.com/openapi.json): the API described in OpenAPI format.