MozOut Documentation

Start here

Get started with the APIFrom your first request to your first key, in a few minutes.

Authentication and keysHow to create a key, use it in requests and keep it safe.

PermissionsWhat each key can do, by area, and the permissions that stay separate.

API rulesThe rules that apply to every operation: errors, limits, pagination, retries and the Sandbox and Production modes.

API referenceEvery API operation, with a filter, linking to the page of each area.

PlaygroundChoose an operation, fill in the request and see the API response, with the code ready in curl, PHP, Python and JavaScript.

What the API does today

The API is growing in phases. This version has 148 operations:

GET /v1/ping: Check that the API is responding
GET /v1/token: See the key in use
GET /v1/limits: See the limits of the key
GET /v1/actions/{id}: Follow a long-running operation
GET /v1/openapi.json: Download this specification
GET /v1/sms/messages: List sent messages
POST /v1/sms/messages: Send an SMS
GET /v1/sms/messages/{id}: See one SMS
GET /v1/sms/balance: See the SMS balance
GET /v1/sms/senders: List the SMS senders
POST /v1/sms/senders: Request a sender
GET /v1/account: See the account
GET /v1/account/contacts: List the contacts
GET /v1/account/users: List the users
GET /v1/catalog/products: List the products
GET /v1/catalog/tlds: List the domain extensions
GET /v1/catalog/currencies: List the currencies
GET /v1/catalog/billing-cycles: List the billing cycles
GET /v1/domains: List the domains
GET /v1/domains/{domain}: See a domain
GET /v1/services: List the services
GET /v1/services/{id}: See a service
GET /v1/invoices: List the invoices
GET /v1/invoices/{id}: See an invoice
GET /v1/billing/credit: See the credit
GET /v1/billing/transactions: List the transactions
GET /v1/tickets: List the tickets
POST /v1/tickets: Open a ticket
GET /v1/tickets/{id}: See a ticket
GET /v1/support/departments: List the departments
GET /v1/domains/availability: Check a domain name
POST /v1/domains/register: Register a domain
POST /v1/domains/transfer: Transfer a domain to us
POST /v1/domains/{domain}/renew: Renew a domain
GET /v1/domains/{domain}/nameservers: See the nameservers
PUT /v1/domains/{domain}/nameservers: Change the nameservers
GET /v1/domains/{domain}/lock: See the transfer lock
PUT /v1/domains/{domain}/lock: Change the transfer lock
PUT /v1/domains/{domain}/auto-renew: Change auto-renewal
GET /v1/domains/{domain}/contacts: See the domain contacts
POST /v1/domains/{domain}/transfer-code: Request the transfer code
GET /v1/domains/{domain}/dns: List the DNS records
POST /v1/domains/{domain}/dns: Add a DNS record
POST /v1/domains/{domain}/dns/validate: Check a DNS record
PUT /v1/domains/{domain}/dns/{record_id}: Change a DNS record
DELETE /v1/domains/{domain}/dns/{record_id}: Delete a DNS record
POST /v1/domains/{domain}/dns/reset: Reset the DNS zone
GET /v1/domains/{domain}/dns/backups: List the zone backups
POST /v1/domains/{domain}/dns/backups/{id}/restore: Restore a zone backup
GET /v1/invoices/{id}/pdf: Get the PDF of an invoice
POST /v1/invoices/{id}/pay: Pay an invoice with credit
GET /v1/orders: List the orders
GET /v1/orders/{id}: See an order
GET /v1/quotes: List the quotes
GET /v1/quotes/{id}: See a quote
GET /v1/services/{id}/billing-cycles: See the renewal cycles of a service
PUT /v1/services/{id}/billing-cycle: Change the cycle of the next renewal
GET /v1/services/{id}/upgrade-link: Get the upgrade link of a service
POST /v1/services/{id}/cancellation: Request the cancellation of a service
POST /v1/tickets/{id}/replies: Reply to a ticket
POST /v1/tickets/{id}/close: Close a ticket
GET /v1/kb/categories: List the Knowledge Base categories
GET /v1/kb/articles: List or search Knowledge Base articles
GET /v1/kb/articles/{id}: Read a Knowledge Base article
GET /v1/announcements: List the announcements
GET /v1/announcements/{id}: Read an announcement
GET /v1/servers: List the servers
GET /v1/servers/{id}: See a server
GET /v1/servers/{id}/traffic: See the traffic of the month
GET /v1/servers/{id}/operating-systems: List the systems to reinstall
GET /v1/servers/{id}/backups: List the backups
POST /v1/servers/{id}/backups: Make a backup
POST /v1/servers/{id}/start: Start a server
POST /v1/servers/{id}/stop: Stop a server
POST /v1/servers/{id}/restart: Restart a server
POST /v1/servers/{id}/password: Generate a new root password
GET /v1/servers/{id}/reverse-dns: See the reverse DNS
PUT /v1/servers/{id}/reverse-dns: Change the reverse DNS
GET /v1/servers/{id}/timezone: See the time zone
PUT /v1/servers/{id}/timezone: Change the time zone
POST /v1/servers/{id}/reinstall: Reinstall a server
POST /v1/servers/{id}/restore: Restore a backup
GET /v1/services/{id}/usage: See disk, traffic and resource usage
POST /v1/services/{id}/cpanel-login: Create a direct login link
GET /v1/services/{id}/subdomains: List subdomains
POST /v1/services/{id}/subdomains: Create a subdomain
DELETE /v1/services/{id}/subdomains/{domain}: Delete a subdomain
GET /v1/services/{id}/addon-domains: List addon domains
POST /v1/services/{id}/addon-domains: Add an addon domain
DELETE /v1/services/{id}/addon-domains/{domain}: Remove an addon domain
GET /v1/services/{id}/redirects: List redirects
POST /v1/services/{id}/redirects: Create a redirect
DELETE /v1/services/{id}/redirects/{redirect_id}: Delete a redirect
GET /v1/services/{id}/databases: List databases
POST /v1/services/{id}/databases: Create a database
DELETE /v1/services/{id}/databases/{name}: Delete a database
GET /v1/services/{id}/database-users: List database users
POST /v1/services/{id}/database-users: Create a database user
PUT /v1/services/{id}/database-users/{name}/password: Change a database user password
DELETE /v1/services/{id}/database-users/{name}: Delete a database user
PUT /v1/services/{id}/databases/{name}/users/{user}: Give a user access to a database
DELETE /v1/services/{id}/databases/{name}/users/{user}: Remove a user access to a database
GET /v1/services/{id}/cron: List cron jobs
POST /v1/services/{id}/cron: Create a cron job
DELETE /v1/services/{id}/cron/{cron_id}: Delete a cron job
GET /v1/services/{id}/ssl: See the SSL certificates
POST /v1/services/{id}/ssl/autossl: Request free certificates
GET /v1/services/{id}/php: See the PHP version of each site
GET /v1/services/{id}/php/options: See the PHP options
PUT /v1/services/{id}/php/options: Change the PHP options
GET /v1/services/{id}/backups: List backup dates
POST /v1/services/{id}/backups: Request a full backup
GET /v1/services/{id}/ftp-accounts: List FTP accounts
POST /v1/services/{id}/ftp-accounts: Create an FTP account
PUT /v1/services/{id}/ftp-accounts/{login}/password: Change an FTP password
DELETE /v1/services/{id}/ftp-accounts/{login}: Delete an FTP account
GET /v1/services/{id}/email/mailboxes: List mailboxes
POST /v1/services/{id}/email/mailboxes: Create a mailbox
DELETE /v1/services/{id}/email/mailboxes/{address}: Delete a mailbox
PUT /v1/services/{id}/email/mailboxes/{address}/password: Change a mailbox password
PUT /v1/services/{id}/email/mailboxes/{address}/quota: Change a mailbox quota
GET /v1/services/{id}/email/forwarders: List forwarders
POST /v1/services/{id}/email/forwarders: Create a forwarder
DELETE /v1/services/{id}/email/forwarders/{address}/{forward_to}: Delete a forwarder
GET /v1/services/{id}/email/autoresponders: List autoresponders
GET /v1/services/{id}/email/autoresponders/{address}: See an autoresponder
PUT /v1/services/{id}/email/autoresponders/{address}: Save an autoresponder
DELETE /v1/services/{id}/email/autoresponders/{address}: Delete an autoresponder
GET /v1/services/{id}/email/default-address: See the default address
PUT /v1/services/{id}/email/default-address: Change the default address
GET /v1/services/{id}/email/authentication: See SPF, DKIM and DMARC
GET /v1/sms/stats: See sending statistics
GET /v1/sms/templates: List templates
POST /v1/sms/templates: Create a template
GET /v1/sms/templates/{id}: See a template
PATCH /v1/sms/templates/{id}: Change a template
DELETE /v1/sms/templates/{id}: Delete a template
GET /v1/sms/senders/{sender}: See a sender request
GET /v1/sms/opt-outs: List numbers that do not receive
POST /v1/sms/opt-outs: Stop sending to a number
GET /v1/extras/catalog: List extras for sale
GET /v1/extras: List the extras of the account
GET /v1/extras/{id}: See an extra
POST /v1/extras/purchase: Buy an extra
GET /v1/reseller: See the reseller programs
GET /v1/reseller/services: List reseller accounts
GET /v1/reseller/services/{id}: See a reseller account
POST /v1/sms/messages/{id}/cancel: Cancel a scheduled SMS

What is not on this list does not exist in the API yet. For now, those tasks are done in My MozOut.

API areas

DomainsCheck, register, renew and transfer domains, and manage nameservers, the lock and auto-renewal through the API.

DNSRead and change the DNS zones of your domains through the API, with a copy before each change.

HostingSee the services of the account and manage a hosting account through the API: usage, domains, databases, cron, SSL, PHP, backups and FTP.

EmailManage the mailboxes of a hosting account through the API: passwords, quotas, forwarders, autoresponders, default address, SPF, DKIM and DMARC.

ServersSee the state, start, stop, restart, change the password and reinstall your VPS servers through the API.

SMSSend SMS through the API and see the history, statistics, balance, templates, senders and numbers that do not receive.

Invoices and creditSee invoices and pay them with credit, see orders and quotes, change the renewal cycle and request a cancellation through the API.

Account and securitySee the account details, contacts and users through the API.

CatalogSee the products, domain extensions, currencies and billing cycles through the API.

SupportOpen, reply to and close tickets, and read Knowledge Base articles and announcements through the API.

Extra productsSee the certificates, SiteLock, radio and other extras of the account, look at the catalog and buy with credit through the API.

ResellerSee the reseller programs of the account and the reseller hosting accounts through the API.

Key and statusConfirm that the API answers, see what the key can do, follow long operations and download the specification.

MozOut documentation

First steps

Start here

What the API does today

API areas