Reference
Multi-Tenant SHA Provider API
The supported provider automation surface of a multi-tenant Sendense Hub Appliance (SHA): an OpenAPI reference at /api/sha and a full provider onboarding guide.
Overview
A multi-tenant Sendense Hub Appliance exposes a provider API: the operations a CSP or MSP drives from its own server-side automation to run migration and disaster recovery for its tenants on one appliance. The interactive OpenAPI 3.1 reference is published at /api/sha, and the raw profile can be downloaded from /SHA_MULTI_TENANT_CSP_OPENAPI.yaml.
The profile is a generated projection of the appliance's canonical contract — same host, same /api/v1 paths, same schemas — filtered to the supported provider surface. It is not the complete internal or first-party SHA API.
Start with the onboarding guide
The step-by-step integration guide at /docs/multi-tenant-sha-provider-api covers the full workflow from tenant onboarding through irreversible cutover, including permission design, retry rules, and the stated limitations of the first release.
What The Profile Covers
The provider workflow, end to end:
- Tenant, site, and user onboarding, including idempotent creation and offboarding.
- Credential provisioning and VM discovery against tenant platforms.
- Replication patterns, VM attachment, sync, and status polling.
- Test failover, planned and unplanned failover, rollback, and commit.
- Licence, consumption, and health monitoring.
Safety Boundary
The provider credential is a server-side credential: it reaches every tenant on the appliance and is never issued to a tenant or placed in a browser. Site API tokens are not accepted anywhere in this profile.
Operator remediation routes — per-target deletion and retry, failover cleanup and force-cleanup — are deliberately outside the published provider surface for the first release; targets that require reconciliation are handled through the documented reconciliation workflow instead.
Related Docs