API
Connect another application to SHM to check information or carry out hosting tasks automatically.
Where to find it: Documentation > Hosting Manager > API > API.
Available to: Anyone reading the public documentation. The related SHM action still follows the role stated on its page.
Before you start
Examples use placeholder accounts, domains, addresses, and credentials. Replace them deliberately, and never paste passwords, API keys, tokens, or private keys into tickets or shared notes.
Why use it — and when not to
Use API to understand or plan the supported workflow. Do not treat an example as authorization or as proof of the current state on a particular SHM server.
Purpose and scope
Use the API Reference when connecting SHM to billing systems, customer portals, account creation tools, support dashboards, monitoring platforms, or controlled internal automation. The public reference documents stable customer, reseller, and root integration endpoints only. Private panel helpers, private AI runtime routes, and messaging-channel worker routes are intentionally not published as external contracts.
Reference navigation
| Page | Use it for |
|---|---|
| API Overview | Understand base URL conventions, request format, response format, public scope, and integration best practices. |
| Authentication | Learn which headers are required, how API identities are scoped, and how keys should be protected and rotated. |
| Permissions | Understand Root, Reseller, and User boundaries before choosing an endpoint or creating an API key. |
| Error Format | Read the standard error structure and learn how to react to authentication, permission, validation, not-found, conflict, and rate/operation errors. |
| API Examples | Copy safe request patterns for cURL, PHP, and JavaScript integrations using placeholder data. |
| Root API | Provider and administrator operations that affect server-wide policy, services, security, licensing, packages, accounts, backups, and operational tooling. |
| Reseller API | Delegated customer-management operations for resellers, limited by ownership, packages, assigned accounts, and provider policy. |
| User API | Account-owned operations for domains, DNS, SSL, mail, databases, files, backups, logs, runtimes, and self-service tools. |
Recommended reading order
- Start with API Overview to understand request shape and the public automation boundary.
- Read Authentication and Permissions before creating API keys for staff, resellers, customers, or external systems.
- Use API Examples to confirm your client sends headers, JSON, and query parameters correctly.
- Open the role-specific API page that matches the identity you will use in production.
- For that makes changes operations, test in a controlled account first and verify the result in the related SHM UI page.
How to use it
- Choose the API reference for your administrator, reseller or account login.
- Read Authentication and try a request that only reads information.
- Use the action's parameters and example when you are ready to make a change.
Explicit reseller routes and long-running operations
The public reference now includes the explicit /v1/resellers/{reseller}/... namespace. It makes reseller scope visible in the URL while preserving ownership, capacity, feature, and source-policy checks. A reseller may target only its own identifier; root may select an authorized reseller.
Long-running service, Compose, migration, backup, and restore workflows can return an operation/task identifier. Follow the corresponding status/log endpoint and preserve terminal errors. Do not equate an accepted or queued operation with a completed result.
Theme color