Apache Guacamole · JSON Structure

Guacamole Rest Connection Structure

Remote desktop connection configuration

Type: object Properties: 6
ApacheOpen SourceRDPRemote AccessRemote DesktopSSHVNCWeb Gateway

Connection is a JSON Structure definition published by Apache Guacamole, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

identifier name protocol parentIdentifier activeConnections parameters

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-guacamole/refs/heads/main/json-structure/guacamole-rest-connection-structure.json",
  "name": "Connection",
  "description": "Remote desktop connection configuration",
  "type": "object",
  "properties": {
    "identifier": {
      "type": "string",
      "description": "Unique connection identifier"
    },
    "name": {
      "type": "string",
      "description": "Human-readable connection name"
    },
    "protocol": {
      "type": "string",
      "description": "Remote desktop protocol"
    },
    "parentIdentifier": {
      "type": "string",
      "description": "Parent connection group identifier (ROOT for top-level)"
    },
    "activeConnections": {
      "type": "int32",
      "description": "Number of active sessions for this connection"
    },
    "parameters": {
      "type": "object",
      "description": "Protocol-specific connection parameters"
    }
  }
}