Skip to main content

DesktopStatusResponse

HTTP API schema for DesktopStatusResponse.

{
  "type": "object",
  "required": [
    "state"
  ],
  "properties": {
    "display": {
      "type": "string",
      "nullable": true
    },
    "installCommand": {
      "type": "string",
      "nullable": true
    },
    "lastError": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DesktopErrorInfo"
        }
      ],
      "nullable": true
    },
    "missingDependencies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "processes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DesktopProcessInfo"
      }
    },
    "resolution": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DesktopResolution"
        }
      ],
      "nullable": true
    },
    "runtimeLogPath": {
      "type": "string",
      "nullable": true
    },
    "startedAt": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "$ref": "#/components/schemas/DesktopState"
    },
    "windows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DesktopWindowInfo"
      },
      "description": "Current visible windows (included when the desktop is active)."
    }
  }
}

Related schemas: DesktopErrorInfo, DesktopProcessInfo, DesktopResolution, DesktopState, DesktopWindowInfo.