Management API fundamentals

Use the Management API to create, configure, and check Hosting and Delivery resources: domains, mailboxes, Delivery accounts, suppression lists, logs, reports, migrations, and more.

What you can manage

Hosting resources

Domains and domain ownership checks.
Mailboxes and postmaster accounts.
Email aliases and domain aliases.
Email signatures.
Address books and contacts.
Imports, migrations, and Vault archiving.
Email log analysis logs for access, incoming mail, and outgoing mail.

Delivery resources

Delivery dashboard data.
Delivery domains and DNS verification.
Delivery accounts for transactional or newsletter sending.
Delivery suppression lists.
Delivery TraceMail logs, counters, daily statistics, accounts, and domains.

Account and delegation resources

Managers.
Team members.
Permissions and assigned resources.
Reports and exports.

Authentication

Management API requests use the X-Api-Token header.

curl "https://api.qboxmail.com/api/delivery/accounts" \
  -H "X-Api-Token: <MANAGEMENT_API_TOKEN>"

The authenticated user controls the scope of each request. For example, a manager sees only assigned resources, while a customer sees the customer's resources.

In production, an API token can manage billable resources only after the customer has a billing profile in Qboxmail billing. If the customer has no billing profile yet, log into the Qboxmail panel and complete the first order before automating paid provisioning with the Management API.

This requirement applies to API-token requests that create or change billable service resources, for example:

creating Hosting domains, mailboxes, imports, migrations, or Vault imports;
creating Delivery accounts;
changing Delivery plans or buying extra Delivery messages.

Hosting trial, Free Hosting, and sandbox exceptions

Active, non-expired Hosting trial customers and Free Hosting customers can manage Hosting resources via API without a billing profile. This exception applies only to Hosting resources, not Delivery. The sandbox environment also does not require a production billing profile.

If the billing profile is missing, production API-token provisioning requests return 403 Forbidden with a message telling the user to complete the first order in the panel.

Response model

Most successful Management API responses look like this:

{
  "resources": [],
  "pagination": {}
}

List endpoints return resources plus pagination details. Single-resource endpoints usually return one item inside resources. Delete endpoints often return 204 No Content.

Resource status

Many Management API operations start background work. For example, domain activation, DNS verification, mailbox provisioning, DKIM setup, and some deletions can be asynchronous.

When a resource includes status fields, treat them as part of the workflow:

status: whether the resource is enabled or active.
status_detail: why the resource is waiting, updating, disabled, or blocked.
DNS or approval status fields: whether external configuration is complete.

What this API does not do

The Management API does not send email content. It creates and configures the Delivery account, sending domains, suppression lists, and other resources that the Send API later uses to send email.

Rule of thumb

If the request changes a Qboxmail resource, use the Management API. If the request sends email through an existing Delivery account, use the Send API.