API reference

All 401 endpoints

401 shown

Loading the endpoint index…

The 25 groups

Meta & discovery

Health, token identity, capabilities, and the /resolve disambiguator every other call leans on.

Account & access

Profile, preferences, guest access — who the account is and who may act on it.

Billing & invoices

Invoices, PDFs, payment links, billing profiles and the prepaid balance.

Products & purchasing

The catalogue and TLD pricing an order is built from.

Services

Every subscription: status, renewal quotes, billing cycle, autorenew, cancellation.

Domains

Registrar-side domain state: expiry, nameservers, contacts.

DNS zones & records

Zones and records on our nameservers, plus a derived health check.

Web hosting account

The DirectAdmin account itself: usage, PHP, resources and single-use panel logins.

Email

Mailboxes, quotas, forwarders, autoresponders, vacation and delivery tracing.

Databases

MySQL databases, users, sizes and single-use phpMyAdmin links.

FTP & SSH access

FTP accounts, SSH keys and shell access state.

SSL / TLS

Certificate status and Let’s Encrypt issuance.

PHP & runtime

Per-domain PHP version, handler and extensions.

Cron jobs

Scheduled tasks on the hosting account.

File manager

Directory listings, disk usage by path, and archive operations.

Backups & restores

Available restore points and the confirmation-tier restore flow.

Applications

WordPress, Installatron and LiteSpeed cache management.

Security

IP blocks, malware findings and protected directories.

Logs & monitoring

Error, access and email logs, and what is available to read.

VPS

Power state, console, install media and server detail. Reinstall, resize, delete and snapshots are done in the client area.

Broadband

Fiber delivery lookup: which addresses we reach, and what the speed tiers cost there.

Other service types

VPN, storage, colocation and everything else on the account.

Migrations & onboarding

Inbound migration requests and their progress.

Diagnostics

Composite reads that answer a question instead of returning raw data.

Support

Tickets, replies and attachments.

The shape of a page

Each endpoint page carries the same seven sections, in the same order:

Header — method, path, a one-line summary, required-scope chips and the execution tier.
Description — written for an agent as much as for a person: what it returns, what it does not do, and which sibling to use instead.
Parameters — path, query and body, one table each, with types, constraints and where every id comes from.
Response — the schema tree and a real example, both in the code rail.
Errors — every code this endpoint can return, each linking to its own page.
Related endpoints — three or four siblings, because the right call is often next door.
Contextual menu — copy the page, view it as Markdown, open it in an assistant.

Reading a path

Paths are /api/v1/{resource}, with /actions/{verb} for anything that is not plain CRUD. On an action path the method carries the intent:

GET Prices it, previews it, lists the options. Safe to call, and the right dry run.

POST Performs it. Confirmation-tier operations return a link here rather than executing.

DELETE Cancels a scheduled one — an autogiro draw, a pending cancellation, an unpaid order.

Hosting resources use {accountId} rather than {id}, and resources with a canonical name use it directly: {address} for a mailbox, {tld} for a TLD, {domain} for a zone.