v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-2692919.9 KB
Setup

Get persisted first-run onboarding state

Returns the persisted deployment draft and generated license request artifact, if present, so the setup UI can resume after a browser restart.

get/onboarding/state

Response

Current setup onboarding state.

gateOpenboolean required
resumeStepinteger required

Example response

{
  "deployment": {
    "deployment": {
      "baseDomains": [
        "edk.example.com"
      ]
    }
  },
  "generatedRequest": {
    "request": {
      "deployment": {
        "baseDomains": [
          "edk.example.com"
        ]
      },
      "localPublicKey": {
        "providerId": "license"
      }
    }
  }
}