API Overview
Learn how to send your first request to the SHM API.
Where to find it: Documentation > Hosting Manager > API > API Overview.
Available to: Anyone may read this reference. Calling an endpoint still requires an API identity whose role, scopes, ownership, IP access rules, and feature access permit the operation.
What this page does
Use the API for repeatable automation, integrations, support tooling, and monitoring. The public API runs on the SHM Engine HTTPS listener at port 882; a panel hostname without that port is not the direct Engine base used by these examples.
Before you start
Create a dedicated API identity, store its key as a secret, and know whether the task belongs to root, reseller, or one account. Read the current resource before a change and obtain real ids from list or context endpoints.
Base URL and path
| Item | Correct value | Meaning |
|---|---|---|
| Panel host | panel.example.com | Replace this placeholder with the hostname used to reach SHM. |
| Engine origin | https://panel.example.com:882 | Port 882 is part of the direct SHM Engine address. |
| Public API base | https://panel.example.com:882/v1 | Append the documented public path. Keep /v1 in the address as shown. |
| Example endpoint | GET https://panel.example.com:882/v1/accounts/demo | Replace path placeholders before sending the request. |
Choosing the right fields
Open an action to see the fields it accepts. Each field explains where to send it, whether it is required and which values you can use. Start with the example for your task, then add any optional fields you need. The complete template lists all fields, including alternatives that should not be sent together.
Request anatomy
| Part | How to send it | Example |
|---|---|---|
| Path parameter | Replace the named braces in the URL and URL-encode the value. | {username} becomes demo. |
| Query parameter | Append it after ?; encode names and values. | ?start=0&length=50. |
| JSON parameter | Send a JSON object with Content-Type: application/json. | {"enabled": true}. |
| Query or JSON | Use either accepted location stated by the endpoint, not both unless its workflow explicitly says so. | Follow the location shown beside the field. |
Access checks
Your API key must be active and have access to the selected account and action. If IP restrictions are enabled, send the request from an allowed address. SHM checks the fields you send and returns a result or an error explaining what needs attention.
Find an action
Choose Root API for server administration, Reseller API for managing customer accounts, or User API for account tasks.
Using the assistant
If you prefer to describe a task in your own words, use AI Mode. It follows your account permissions and cannot make otherwise unavailable tools accessible.
How to use it
- Choose the smallest role that owns the task.
- Copy the Engine origin with port
882. - Open the matching Root, Reseller, or User API endpoint card.
- Review every parameter and the complete request template.
- Build one valid workflow request and verify changes with a follow-up read.
Reseller accounts and tasks that take time
In a reseller URL, replace {reseller} with your reseller username. A reseller may manage only its own accounts; an administrator may select the appropriate reseller.
Some tasks, such as backups, restores and migrations, continue after the first response. Keep the task or operation ID and use the matching status action to check progress. An accepted request is not yet a finished task.
Result and next check
You have a request that reaches the SHM Engine on the correct port, carries every key required by its chosen workflow, and stays inside the intended access permissions.
Theme color