API Reference

Your Magnus Box account includes a full REST API. Every action available in the web dashboard can also be performed programmatically, because the dashboard itself is built entirely on this same public API. This makes the API well suited to automating account administration: provisioning users and devices, triggering backups and restores, pulling job history, and integrating Magnus Box with your own portal, PSA, or RMM tooling.

Finding the endpoint reference

The authoritative list of endpoints, parameters, and data structures is the API reference for your Magnus Box account, which tracks the version your account is running. To get your API access details and the endpoint reference for your account, contact Magnus Box at support@magnusbox.com.

Tip: the web dashboard uses these same API calls under the hood. To see a real-world example of any request, and to confirm the exact API address for your account, open your browser developer tools, go to the Network tab, and perform an action in the dashboard. You will see the exact endpoint and payload the interface sends.

Authentication

All admin API endpoints require an administrative account. You can use your normal dashboard admin login, or you can request a dedicated administrative account for API use by emailing support. Requests are sent as POST to paths under /api/v1/admin/ and return JSON.

Every request is authenticated by including credential fields, most importantly:

• Username: the admin account name.
• AuthType: the authentication method. Valid values are Password, SessionKey, PasswordTOTP, and PasswordU2F.
• Password, SessionKey, TOTP, or U2FSign: supplied as required by the chosen AuthType.

For anything beyond one-off calls, authenticate once and reuse a session key. Call AdminAccountSessionStart to exchange your credentials for a session key, then pass that key on subsequent requests with AuthType set to SessionKey. Call AdminAccountSessionRevoke to log the session out. If your admin account uses two-factor authentication, use the matching PasswordTOTP or PasswordU2F type. Always confirm the exact field names and requirements against your server's live reference before building against an endpoint.

Common use cases

The admin API is most often used to automate account management that would otherwise be manual dashboard work. Typical examples include:

• Automated user provisioning: create accounts as customers sign up, then set their profile, policy, and email settings.
• Storage and device management: request storage on behalf of a user, list a user's devices, and revoke a device when it is decommissioned.
• Backup and restore orchestration: list live connected devices and instruct a device to run a backup or perform a restore.
• Reporting and monitoring: pull job history and job logs to feed dashboards, billing, or alerting.
• Deprovisioning: suspend or delete accounts as part of an offboarding workflow.

The self-documenting reference groups every available endpoint (each named with an Admin prefix, for example AdminAddUser, AdminListUsers, or AdminRequestStorageVault) alongside its parameters and response structures. Use it to confirm the precise call for your version rather than relying on a static list.

Use the API with care

The admin API can create, modify, and permanently delete accounts, devices, and their configuration. Some actions can cause irreversible data loss, and encrypted data cannot be recovered once the associated user profile is removed. Test against a non-production account first, and if you are unsure how an endpoint behaves, ask support before running it against live data. Usage of the API is at your own risk.

Getting help

If you have questions about a specific endpoint, need a dedicated API admin account, or want guidance on an integration, contact our team at support@magnusbox.com before proceeding.