First-run setup wizard progress

GET

/v1/console/setup-status

curl --request GET \
  --url https://example.com/v1/console/setup-status \
  --header 'Authorization: Bearer <token>'

• this engine

Returns which first-run setup steps the deployment has completed, so the console wizard can resume onboarding at the right step.

Authorizations

• bearerAuth
• browserSession

Responses

200

OK

Media type application/json

object

completed

required

boolean

steps

required

Array<object>

object

applicable

Present and false ONLY for a step this build or deployment cannot complete. completed above is computed over the APPLICABLE steps, so one unwireable step does not report a finished install as unfinished.

boolean

completed

boolean

id

string

reason

Why the step is incomplete or not applicable. An incomplete step without a reason is a to-do item with no instructions.

string

Example ^generated

{
  "completed": true,
  "steps": [
    {
      "applicable": true,
      "completed": true,
      "id": "example",
      "reason": "example"
    }
  ]
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}