Start the private desktop runtime.

POST /v1/desktop/start: request parameters and responses.

POST /v1/desktop/start

Lazily launches the managed Xvfb/openbox stack, validates display health, and returns the resulting desktop status snapshot.

Request body

Required.

application/json

{
  "schema": {
    "$ref": "#/components/schemas/DesktopStartRequest"
  }
}

Related schemas: DesktopStartRequest.

Responses

200

Desktop runtime status after start

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/DesktopStatusResponse"
  }
}

Related schemas: DesktopStatusResponse.

400

Invalid desktop start request

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.

409

Desktop runtime is already transitioning

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.

501

Desktop API unsupported on this platform

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.

503

Desktop runtime could not be started

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.