Tell the player to start the InitBox process

Published on Aug 7, 2026

Prev Next

Post

/v{version}/PlayerProvisioning/quick/startInitBox/{boxId}

The quick install feature must be activated on the server via server configuration.

Path parameters

boxId

stringRequired

Unique box ID of the player

version

stringRequired

The requested API version

Body parameters

The additional parameters containing information to start the InitBox process

object

RootPassword

string

Responses

200

InitBox process started successfully.

object

400

Bad request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

401

Unauthorized

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

403

Quick install feature is disabled.

Expand All

object

Detail

string

Instance

string

Status

integer (int32)

Title

string

Type

string

property*

object additionalProperties

404

Player not found or no valid license.

Expand All

object

Detail

string

Instance

string

Status

integer (int32)

Title

string

Type

string

property*

object additionalProperties

409

Player already initialized.

Expand All

object

Detail

string

Instance

string

Status

integer (int32)

Title

string

Type

string

property*

object additionalProperties

500

Unexpected error

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties