# API reference

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

Updated on 10 November 2026

This index comes from the OpenAPI specification, the same one the API uses. Each operation leads to the page of its area, where it is explained and can be tried.

## Base address

```text
https://api.mozout.com/v1
```

## Operations

### [Domains](https://docs.mozout.com/en/domains.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/domains`](https://docs.mozout.com/en/domains.md) | List the domains |
| `GET` | [`/v1/domains/{domain}`](https://docs.mozout.com/en/domains.md) | See a domain |
| `GET` | [`/v1/domains/availability`](https://docs.mozout.com/en/domains.md) | Check a domain name |
| `POST` | [`/v1/domains/register`](https://docs.mozout.com/en/domains.md) | Register a domain |
| `POST` | [`/v1/domains/transfer`](https://docs.mozout.com/en/domains.md) | Transfer a domain to us |
| `POST` | [`/v1/domains/{domain}/renew`](https://docs.mozout.com/en/domains.md) | Renew a domain |
| `GET` | [`/v1/domains/{domain}/nameservers`](https://docs.mozout.com/en/domains.md) | See the nameservers |
| `PUT` | [`/v1/domains/{domain}/nameservers`](https://docs.mozout.com/en/domains.md) | Change the nameservers |
| `GET` | [`/v1/domains/{domain}/lock`](https://docs.mozout.com/en/domains.md) | See the transfer lock |
| `PUT` | [`/v1/domains/{domain}/lock`](https://docs.mozout.com/en/domains.md) | Change the transfer lock |
| `PUT` | [`/v1/domains/{domain}/auto-renew`](https://docs.mozout.com/en/domains.md) | Change auto-renewal |
| `GET` | [`/v1/domains/{domain}/contacts`](https://docs.mozout.com/en/domains.md) | See the domain contacts |
| `POST` | [`/v1/domains/{domain}/transfer-code`](https://docs.mozout.com/en/domains.md) | Request the transfer code |

### [DNS](https://docs.mozout.com/en/dns.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/domains/{domain}/dns`](https://docs.mozout.com/en/dns.md) | List the DNS records |
| `POST` | [`/v1/domains/{domain}/dns`](https://docs.mozout.com/en/dns.md) | Add a DNS record |
| `POST` | [`/v1/domains/{domain}/dns/validate`](https://docs.mozout.com/en/dns.md) | Check a DNS record |
| `PUT` | [`/v1/domains/{domain}/dns/{record_id}`](https://docs.mozout.com/en/dns.md) | Change a DNS record |
| `DELETE` | [`/v1/domains/{domain}/dns/{record_id}`](https://docs.mozout.com/en/dns.md) | Delete a DNS record |
| `POST` | [`/v1/domains/{domain}/dns/reset`](https://docs.mozout.com/en/dns.md) | Reset the DNS zone |
| `GET` | [`/v1/domains/{domain}/dns/backups`](https://docs.mozout.com/en/dns.md) | List the zone backups |
| `POST` | [`/v1/domains/{domain}/dns/backups/{id}/restore`](https://docs.mozout.com/en/dns.md) | Restore a zone backup |

### [Hosting](https://docs.mozout.com/en/hosting.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/services`](https://docs.mozout.com/en/hosting.md) | List the services |
| `GET` | [`/v1/services/{id}`](https://docs.mozout.com/en/hosting.md) | See a service |
| `GET` | [`/v1/services/{id}/usage`](https://docs.mozout.com/en/hosting.md) | See disk, traffic and resource usage |
| `POST` | [`/v1/services/{id}/cpanel-login`](https://docs.mozout.com/en/hosting.md) | Create a direct login link |
| `GET` | [`/v1/services/{id}/subdomains`](https://docs.mozout.com/en/hosting.md) | List subdomains |
| `POST` | [`/v1/services/{id}/subdomains`](https://docs.mozout.com/en/hosting.md) | Create a subdomain |
| `DELETE` | [`/v1/services/{id}/subdomains/{domain}`](https://docs.mozout.com/en/hosting.md) | Delete a subdomain |
| `GET` | [`/v1/services/{id}/addon-domains`](https://docs.mozout.com/en/hosting.md) | List addon domains |
| `POST` | [`/v1/services/{id}/addon-domains`](https://docs.mozout.com/en/hosting.md) | Add an addon domain |
| `DELETE` | [`/v1/services/{id}/addon-domains/{domain}`](https://docs.mozout.com/en/hosting.md) | Remove an addon domain |
| `GET` | [`/v1/services/{id}/redirects`](https://docs.mozout.com/en/hosting.md) | List redirects |
| `POST` | [`/v1/services/{id}/redirects`](https://docs.mozout.com/en/hosting.md) | Create a redirect |
| `DELETE` | [`/v1/services/{id}/redirects/{redirect_id}`](https://docs.mozout.com/en/hosting.md) | Delete a redirect |
| `GET` | [`/v1/services/{id}/databases`](https://docs.mozout.com/en/hosting.md) | List databases |
| `POST` | [`/v1/services/{id}/databases`](https://docs.mozout.com/en/hosting.md) | Create a database |
| `DELETE` | [`/v1/services/{id}/databases/{name}`](https://docs.mozout.com/en/hosting.md) | Delete a database |
| `GET` | [`/v1/services/{id}/database-users`](https://docs.mozout.com/en/hosting.md) | List database users |
| `POST` | [`/v1/services/{id}/database-users`](https://docs.mozout.com/en/hosting.md) | Create a database user |
| `PUT` | [`/v1/services/{id}/database-users/{name}/password`](https://docs.mozout.com/en/hosting.md) | Change a database user password |
| `DELETE` | [`/v1/services/{id}/database-users/{name}`](https://docs.mozout.com/en/hosting.md) | Delete a database user |
| `PUT` | [`/v1/services/{id}/databases/{name}/users/{user}`](https://docs.mozout.com/en/hosting.md) | Give a user access to a database |
| `DELETE` | [`/v1/services/{id}/databases/{name}/users/{user}`](https://docs.mozout.com/en/hosting.md) | Remove a user access to a database |
| `GET` | [`/v1/services/{id}/cron`](https://docs.mozout.com/en/hosting.md) | List cron jobs |
| `POST` | [`/v1/services/{id}/cron`](https://docs.mozout.com/en/hosting.md) | Create a cron job |
| `DELETE` | [`/v1/services/{id}/cron/{cron_id}`](https://docs.mozout.com/en/hosting.md) | Delete a cron job |
| `GET` | [`/v1/services/{id}/ssl`](https://docs.mozout.com/en/hosting.md) | See the SSL certificates |
| `POST` | [`/v1/services/{id}/ssl/autossl`](https://docs.mozout.com/en/hosting.md) | Request free certificates |
| `GET` | [`/v1/services/{id}/php`](https://docs.mozout.com/en/hosting.md) | See the PHP version of each site |
| `GET` | [`/v1/services/{id}/php/options`](https://docs.mozout.com/en/hosting.md) | See the PHP options |
| `PUT` | [`/v1/services/{id}/php/options`](https://docs.mozout.com/en/hosting.md) | Change the PHP options |
| `GET` | [`/v1/services/{id}/backups`](https://docs.mozout.com/en/hosting.md) | List backup dates |
| `POST` | [`/v1/services/{id}/backups`](https://docs.mozout.com/en/hosting.md) | Request a full backup |
| `GET` | [`/v1/services/{id}/ftp-accounts`](https://docs.mozout.com/en/hosting.md) | List FTP accounts |
| `POST` | [`/v1/services/{id}/ftp-accounts`](https://docs.mozout.com/en/hosting.md) | Create an FTP account |
| `PUT` | [`/v1/services/{id}/ftp-accounts/{login}/password`](https://docs.mozout.com/en/hosting.md) | Change an FTP password |
| `DELETE` | [`/v1/services/{id}/ftp-accounts/{login}`](https://docs.mozout.com/en/hosting.md) | Delete an FTP account |

### [Email](https://docs.mozout.com/en/email.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/services/{id}/email/mailboxes`](https://docs.mozout.com/en/email.md) | List mailboxes |
| `POST` | [`/v1/services/{id}/email/mailboxes`](https://docs.mozout.com/en/email.md) | Create a mailbox |
| `DELETE` | [`/v1/services/{id}/email/mailboxes/{address}`](https://docs.mozout.com/en/email.md) | Delete a mailbox |
| `PUT` | [`/v1/services/{id}/email/mailboxes/{address}/password`](https://docs.mozout.com/en/email.md) | Change a mailbox password |
| `PUT` | [`/v1/services/{id}/email/mailboxes/{address}/quota`](https://docs.mozout.com/en/email.md) | Change a mailbox quota |
| `GET` | [`/v1/services/{id}/email/forwarders`](https://docs.mozout.com/en/email.md) | List forwarders |
| `POST` | [`/v1/services/{id}/email/forwarders`](https://docs.mozout.com/en/email.md) | Create a forwarder |
| `DELETE` | [`/v1/services/{id}/email/forwarders/{address}/{forward_to}`](https://docs.mozout.com/en/email.md) | Delete a forwarder |
| `GET` | [`/v1/services/{id}/email/autoresponders`](https://docs.mozout.com/en/email.md) | List autoresponders |
| `GET` | [`/v1/services/{id}/email/autoresponders/{address}`](https://docs.mozout.com/en/email.md) | See an autoresponder |
| `PUT` | [`/v1/services/{id}/email/autoresponders/{address}`](https://docs.mozout.com/en/email.md) | Save an autoresponder |
| `DELETE` | [`/v1/services/{id}/email/autoresponders/{address}`](https://docs.mozout.com/en/email.md) | Delete an autoresponder |
| `GET` | [`/v1/services/{id}/email/default-address`](https://docs.mozout.com/en/email.md) | See the default address |
| `PUT` | [`/v1/services/{id}/email/default-address`](https://docs.mozout.com/en/email.md) | Change the default address |
| `GET` | [`/v1/services/{id}/email/authentication`](https://docs.mozout.com/en/email.md) | See SPF, DKIM and DMARC |

### [Servers](https://docs.mozout.com/en/servers.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/servers`](https://docs.mozout.com/en/servers.md) | List the servers |
| `GET` | [`/v1/servers/{id}`](https://docs.mozout.com/en/servers.md) | See a server |
| `GET` | [`/v1/servers/{id}/traffic`](https://docs.mozout.com/en/servers.md) | See the traffic of the month |
| `GET` | [`/v1/servers/{id}/operating-systems`](https://docs.mozout.com/en/servers.md) | List the systems to reinstall |
| `GET` | [`/v1/servers/{id}/backups`](https://docs.mozout.com/en/servers.md) | List the backups |
| `POST` | [`/v1/servers/{id}/backups`](https://docs.mozout.com/en/servers.md) | Make a backup |
| `POST` | [`/v1/servers/{id}/start`](https://docs.mozout.com/en/servers.md) | Start a server |
| `POST` | [`/v1/servers/{id}/stop`](https://docs.mozout.com/en/servers.md) | Stop a server |
| `POST` | [`/v1/servers/{id}/restart`](https://docs.mozout.com/en/servers.md) | Restart a server |
| `POST` | [`/v1/servers/{id}/password`](https://docs.mozout.com/en/servers.md) | Generate a new root password |
| `GET` | [`/v1/servers/{id}/reverse-dns`](https://docs.mozout.com/en/servers.md) | See the reverse DNS |
| `PUT` | [`/v1/servers/{id}/reverse-dns`](https://docs.mozout.com/en/servers.md) | Change the reverse DNS |
| `GET` | [`/v1/servers/{id}/timezone`](https://docs.mozout.com/en/servers.md) | See the time zone |
| `PUT` | [`/v1/servers/{id}/timezone`](https://docs.mozout.com/en/servers.md) | Change the time zone |
| `POST` | [`/v1/servers/{id}/reinstall`](https://docs.mozout.com/en/servers.md) | Reinstall a server |
| `POST` | [`/v1/servers/{id}/restore`](https://docs.mozout.com/en/servers.md) | Restore a backup |

### [SMS](https://docs.mozout.com/en/sms.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/sms/messages`](https://docs.mozout.com/en/sms.md) | List sent messages |
| `POST` | [`/v1/sms/messages`](https://docs.mozout.com/en/sms.md) | Send an SMS |
| `GET` | [`/v1/sms/messages/{id}`](https://docs.mozout.com/en/sms.md) | See one SMS |
| `GET` | [`/v1/sms/balance`](https://docs.mozout.com/en/sms.md) | See the SMS balance |
| `GET` | [`/v1/sms/senders`](https://docs.mozout.com/en/sms.md) | List the SMS senders |
| `POST` | [`/v1/sms/senders`](https://docs.mozout.com/en/sms.md) | Request a sender |
| `GET` | [`/v1/sms/stats`](https://docs.mozout.com/en/sms.md) | See sending statistics |
| `GET` | [`/v1/sms/templates`](https://docs.mozout.com/en/sms.md) | List templates |
| `POST` | [`/v1/sms/templates`](https://docs.mozout.com/en/sms.md) | Create a template |
| `GET` | [`/v1/sms/templates/{id}`](https://docs.mozout.com/en/sms.md) | See a template |
| `PATCH` | [`/v1/sms/templates/{id}`](https://docs.mozout.com/en/sms.md) | Change a template |
| `DELETE` | [`/v1/sms/templates/{id}`](https://docs.mozout.com/en/sms.md) | Delete a template |
| `GET` | [`/v1/sms/senders/{sender}`](https://docs.mozout.com/en/sms.md) | See a sender request |
| `GET` | [`/v1/sms/opt-outs`](https://docs.mozout.com/en/sms.md) | List numbers that do not receive |
| `POST` | [`/v1/sms/opt-outs`](https://docs.mozout.com/en/sms.md) | Stop sending to a number |
| `POST` | [`/v1/sms/messages/{id}/cancel`](https://docs.mozout.com/en/sms.md) | Cancel a scheduled SMS |

### [Invoices and credit](https://docs.mozout.com/en/billing.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/invoices`](https://docs.mozout.com/en/billing.md) | List the invoices |
| `GET` | [`/v1/invoices/{id}`](https://docs.mozout.com/en/billing.md) | See an invoice |
| `GET` | [`/v1/billing/credit`](https://docs.mozout.com/en/billing.md) | See the credit |
| `GET` | [`/v1/billing/transactions`](https://docs.mozout.com/en/billing.md) | List the transactions |
| `GET` | [`/v1/invoices/{id}/pdf`](https://docs.mozout.com/en/billing.md) | Get the PDF of an invoice |
| `POST` | [`/v1/invoices/{id}/pay`](https://docs.mozout.com/en/billing.md) | Pay an invoice with credit |
| `GET` | [`/v1/orders`](https://docs.mozout.com/en/billing.md) | List the orders |
| `GET` | [`/v1/orders/{id}`](https://docs.mozout.com/en/billing.md) | See an order |
| `GET` | [`/v1/quotes`](https://docs.mozout.com/en/billing.md) | List the quotes |
| `GET` | [`/v1/quotes/{id}`](https://docs.mozout.com/en/billing.md) | See a quote |
| `GET` | [`/v1/services/{id}/billing-cycles`](https://docs.mozout.com/en/billing.md) | See the renewal cycles of a service |
| `PUT` | [`/v1/services/{id}/billing-cycle`](https://docs.mozout.com/en/billing.md) | Change the cycle of the next renewal |
| `GET` | [`/v1/services/{id}/upgrade-link`](https://docs.mozout.com/en/billing.md) | Get the upgrade link of a service |
| `POST` | [`/v1/services/{id}/cancellation`](https://docs.mozout.com/en/billing.md) | Request the cancellation of a service |

### [Account and security](https://docs.mozout.com/en/account.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/account`](https://docs.mozout.com/en/account.md) | See the account |
| `GET` | [`/v1/account/contacts`](https://docs.mozout.com/en/account.md) | List the contacts |
| `GET` | [`/v1/account/users`](https://docs.mozout.com/en/account.md) | List the users |

### [Catalog](https://docs.mozout.com/en/catalog.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/catalog/products`](https://docs.mozout.com/en/catalog.md) | List the products |
| `GET` | [`/v1/catalog/tlds`](https://docs.mozout.com/en/catalog.md) | List the domain extensions |
| `GET` | [`/v1/catalog/currencies`](https://docs.mozout.com/en/catalog.md) | List the currencies |
| `GET` | [`/v1/catalog/billing-cycles`](https://docs.mozout.com/en/catalog.md) | List the billing cycles |

### [Support](https://docs.mozout.com/en/support.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/tickets`](https://docs.mozout.com/en/support.md) | List the tickets |
| `POST` | [`/v1/tickets`](https://docs.mozout.com/en/support.md) | Open a ticket |
| `GET` | [`/v1/tickets/{id}`](https://docs.mozout.com/en/support.md) | See a ticket |
| `GET` | [`/v1/support/departments`](https://docs.mozout.com/en/support.md) | List the departments |
| `POST` | [`/v1/tickets/{id}/replies`](https://docs.mozout.com/en/support.md) | Reply to a ticket |
| `POST` | [`/v1/tickets/{id}/close`](https://docs.mozout.com/en/support.md) | Close a ticket |
| `GET` | [`/v1/kb/categories`](https://docs.mozout.com/en/support.md) | List the Knowledge Base categories |
| `GET` | [`/v1/kb/articles`](https://docs.mozout.com/en/support.md) | List or search Knowledge Base articles |
| `GET` | [`/v1/kb/articles/{id}`](https://docs.mozout.com/en/support.md) | Read a Knowledge Base article |
| `GET` | [`/v1/announcements`](https://docs.mozout.com/en/support.md) | List the announcements |
| `GET` | [`/v1/announcements/{id}`](https://docs.mozout.com/en/support.md) | Read an announcement |

### [Extra products](https://docs.mozout.com/en/extras.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/extras/catalog`](https://docs.mozout.com/en/extras.md) | List extras for sale |
| `GET` | [`/v1/extras`](https://docs.mozout.com/en/extras.md) | List the extras of the account |
| `GET` | [`/v1/extras/{id}`](https://docs.mozout.com/en/extras.md) | See an extra |
| `POST` | [`/v1/extras/purchase`](https://docs.mozout.com/en/extras.md) | Buy an extra |

### [Reseller](https://docs.mozout.com/en/reseller.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/reseller`](https://docs.mozout.com/en/reseller.md) | See the reseller programs |
| `GET` | [`/v1/reseller/services`](https://docs.mozout.com/en/reseller.md) | List reseller accounts |
| `GET` | [`/v1/reseller/services/{id}`](https://docs.mozout.com/en/reseller.md) | See a reseller account |

### [Key and status](https://docs.mozout.com/en/key-status.md)

| Operation | Path | What it does |
|---|---|---|
| `GET` | [`/v1/ping`](https://docs.mozout.com/en/key-status.md) | Check that the API is responding |
| `GET` | [`/v1/token`](https://docs.mozout.com/en/key-status.md) | See the key in use |
| `GET` | [`/v1/limits`](https://docs.mozout.com/en/key-status.md) | See the limits of the key |
| `GET` | [`/v1/actions/{id}`](https://docs.mozout.com/en/key-status.md) | Follow a long-running operation |
| `GET` | [`/v1/openapi.json`](https://docs.mozout.com/en/key-status.md) | Download this specification |

## Specification

[Download the OpenAPI specification](https://docs.mozout.com/openapi.json)