GET
Get Onboarding Status

Authorizations

Authorization
string
header
required

The access token from a signed-in console session, sent as Authorization: Bearer <token>. It must be issued for the Simnet API audience — an identity token, or a token for another application, is refused with 401.

There are no API keys, client secrets or service accounts yet, so this is a personal, short-lived credential carrying your full account access. Programmatic credentials with role-based access are on the roadmap. See Authentication.

Headers

X-Region-Context
string<uuid>

The region to run this request against, as a region UUID. Omit it to use your default region — your primary region if you have one, otherwise the first active one. See Regions.

Response

Success.

Recovered from the code that builds this response. Individual row fields are not yet schema-documented.

onboardingCompleted
boolean
needsOnboarding
boolean
mode
string
hasAnyRegion
boolean
regionCount
integer<int64>
provisioningStatus
string
accountReady
boolean
wizardStep
string
vmSnapshotEnabled
boolean
multiCloudVpcFabric
boolean
cloudsEnabled
boolean
sovereignMode
boolean