Platform setup API

Overview

A fresh DALP platform starts in setup mode. Until an administrator finishes the first install, the platform routes signed-in users into the setup wizard instead of the console. This API exposes that flow as two endpoints: one reads whether the install is finished, and one marks it finished.

Use the status endpoint to drive a sign-in or routing decision in your own client. Use the completion endpoint to close out the install once the platform has a working blockchain connection. Both endpoints return a single completion flag, so you can read state and react in one field.

Read setup status

GET /api/v2/platform-setup/status reports whether the first install is finished. Any authenticated user can call it, which lets a route gate check setup state for every signed-in user without a forbidden error for non-administrators.

curl "https://your-platform.example.com/api/v2/platform-setup/status" \
  -H "X-Api-Key: sm_dalp_xxxxxxxxxxxxxxxx"

{
  "completed": false
}

completed is true once an administrator finishes the install, and false while the platform is still in setup mode. Send the user to the setup wizard on false, and continue to the console on true.

A platform that was already running before the setup flow existed comes up with completed set to true, so an existing deployment never sends its users back through first-install setup after an upgrade.

Complete setup

POST /api/v2/platform-setup/complete marks first-install setup as finished. Only a global administrator can call it. The platform rejects any other caller with a forbidden error before the request runs.

The request takes no body fields.

curl -X POST "https://your-platform.example.com/api/v2/platform-setup/complete" \
  -H "X-Api-Key: sm_dalp_xxxxxxxxxxxxxxxx"

{
  "completed": true
}

On success the platform stores the completed flag and returns completed: true. The endpoint is idempotent: calling it again on a platform that is already set up returns the same completed: true response without side effects.

Configure an RPC endpoint first

Completion requires at least one RPC endpoint saved on the platform. Creating the first organization needs a working blockchain connection, so the platform keeps setup open until an administrator adds and saves an RPC endpoint in the setup wizard. A built-in chart or configuration default does not satisfy this requirement on its own; the administrator must save an endpoint.

When no RPC endpoint is saved, completion fails with DALP-9083 (PLATFORM_SETUP_RPC_UPSTREAM_REQUIRED):

Add an RPC endpoint, then call the completion endpoint again.

Response model

Both endpoints return the same shape, so a client reads setup state from one field in either case.

Operational notes

• Read status with any authenticated account, but complete setup only with a global administrator account.
• Add and save an RPC endpoint before you call the completion endpoint, or completion fails with DALP-9083.
• Completion is idempotent, so an automation can call it safely without checking status first.
• An upgraded deployment that predates the setup flow reports completed: true and skips first-install setup.

Related guides

• First admin setup for the operator walkthrough of standing up a new platform.
• Add platform administrators for granting the global administrator role. Completion needs that role.
• Configure RPC upstream pools for the admin task that adds the RPC endpoints setup requires.
• Error handling for retry and failure-handling patterns.