Embed-status
Embed-status — 1 operations on https://api.hanzo.ai.
The REST reference for Embed-status — 1 operations, generated from the OpenAPI document.
| Base URL | https://api.hanzo.ai |
| Operations | 1 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
embed-status
EmbedStatus reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the caller and is actually running, so a console module can choose between the embed and the provision panel.
GET /v1/embed-status
EmbedStatus reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the caller and is actually running, so a console module can choose between the embed and the provision panel.
It answers two questions the browser cannot answer for itself. ENTITLEMENT is server-authoritative: each app is a single shared per-BRAND instance, so only a member of the owning brand org — or a SuperAdmin — is given the embed URL; every other caller gets phase "not-entitled" and no URL. REACHABILITY is a probe of that origin, which a cross-origin page cannot read for itself.
The probed host is always <app>.<this deployment's own brand domain>: no part of it comes from the request, so this can never be steered into probing an arbitrary origin.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
app | query | string | — | App is the embedded app to report on: cms (Content Studio), erp or help. |
How is this guide?