QueryServer API - Get | Pixotope Help Center

AvailableTools [GET]

AvailableTools

Aggregates available tools from all connected DRM servers.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableTools

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableTools",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableTools"
}

JSON

{
  "Value": {
    "PC1-License": [
      "ADDITIONAL_OUTPUT_1",
      "ADDITIONAL_OUTPUT_2",
      "ADDITIONAL_OUTPUT_3",
      "AIDEPTH",
      "AIKEYER",
      "AINORMALS",
      "AR",
      "CAMERATRACKINGPLUGIN",
      "CAMERATRACKINGSERVER",
      "CG",
      "CHROMAKEYER",
      "DATAHUB",
      "DATAMAPPER",
      "DUALCAMERAS",
      "EDITOR",
      "ERIZOS_PLUGINS",
      "FIXEDLENSCALIBRATION",
      "GHOSTRIGGER",
      "LARGE_NETWORK",
      "LIVECONTROLLER",
      "LIVINGPHOTO",
      "LIVINGPHOTO_GENERATOR",
      "MANY_CAMERAS",
      "MARKERPATTERNGENERATOR",
      "MATROX",
      "OFFSETCALCULATOR",
      "RIVERMAX",
      "SDI_AUDIO_DEEMBEDDER",
      "SDI_AUDIO_EMBEDDER",
      "SDK",
      "STUDIOCREATOR",
      "SURVEYOR",
      "TALENTRACKCLIENT",
      "TALENTRACKFRONT",
      "TALENTRACKSERVER",
      "TEXT3D",
      "THIRD_PARTY_TRACKING",
      "TORQTRACKBOX",
      "TTL_TRACKING",
      "VIDEOIO",
      "VIOCHIEF",
      "VIOWORKER",
      "VS",
      "XR",
      "ZONE_TRACKING",
      "ZOOMLENSTRACKING",
      "LICENSE_OFFLINE"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=AvailableTools

Copy and paste into a browser to run - ⚠️ Executes immediately

CaptureCameraImagesProgress [GET]

CaptureCameraImagesProgress

Tracks progress and blurriness metrics for camera image capture operation.

No parameters — message is always {}.

Value

Progress	NUMBER	The progress.
Blurriness	NUMBER	The blurriness.

Example - Get CaptureCameraImagesProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CaptureCameraImagesProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CaptureCameraImagesProgress"
}

JSON

{
  "Value": {
    "Progress": 0,
    "Blurriness": 0
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CaptureCameraImagesProgress

Copy and paste into a browser to run - ⚠️ Executes immediately

DaemonEvents [GET]

DaemonEvents

Aggregates EngineIsStarting events from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DaemonEvents

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonEvents",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonEvents"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "EngineIsStarting": false
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DaemonEvents

Copy and paste into a browser to run - ⚠️ Executes immediately

IOEffects [GET]

IOEffects

Aggregates IO effects (sharpen, visualizer, depth/normal generation, BPE) for all machine media.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get IOEffects

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "IOEffects",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "IOEffects"
}

JSON

{
  "Value": [
    {
      "MachineName": "PC1",
      "Medias": [
        {
          "MediaId": "cf356a1b-57ac-4615-8413-73e5674fc081",
          "MediaName": "Output 1",
          "Sharpen": {
            "Enabled": false,
            "Amplitude": 0.5,
            "Profile": 0.9
          },
          "Visualizer": {
            "Enabled": false,
            "Active": true,
            "HistogramEnabled": false,
            "VectorScopeEnabled": false,
            "WaveformEnabled": false,
            "ShowLogs": false,
            "ShowStatus": false,
            "ShowTimecode": false,
            "DebugTimers": false
          },
          "DepthGeneration": {
            "Enabled": false
          },
          "NormalGeneration": {
            "Enabled": false
          },
          "BPE": null,
          "IOType": "Output"
        }
      ],
      "CustomDirector": {
        "Name": "",
        "Color": ""
      },
      "NVARIsInstalled": true
    }
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=IOEffects

Copy and paste into a browser to run - ⚠️ Executes immediately

LOWPRIO_CombinedSystemInfo [GET]

LOWPRIO_CombinedSystemInfo

Aggregates system information from all connected clients with low priority updates.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get LOWPRIO_CombinedSystemInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "LOWPRIO_CombinedSystemInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "LOWPRIO_CombinedSystemInfo"
}

JSON

{
  "Value": {
    "PC1-Diagnostics": {
      "AMD Ryzen 9 5950X 16-Core Processor            ": {
        "Hottest Core": {
          "Value": null
        },
        "Total CPU Usage": {
          "Value": 10.499153137207031
        },
        "Highest Core Usage": {
          "Value": 38.199310302734375
        },
        "Frequency": {
          "Value": 4370.841763324035
        }
      },
      "NVIDIA GeForce RTX 5070 Ti": {
        "Temperature": {
          "Value": 46
        },
        "Total GPU Usage": {
          "Value": 3
        },
        "GPU Memory Usage": {
          "Value": 14.764034035146906
        },
        "Frequency": {
          "Value": 2535
        },
        "Throttling": {
          "Value": false
        }
      },
      "Memory": {
        "Physical Memory Usage": {
          "Value": 37.34751880482783
        },
        "Virtual Memory Usage": {
          "Value": 0
        }
      },
      "Fans": {}
    },
    "PC1-Pipeline": {
      "VideoCard": null
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=LOWPRIO_CombinedSystemInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

MachineGroups [GET]

MachineGroups

Maps connected machines to their default, custom, and feature group memberships.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MachineGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachineGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachineGroups"
}

JSON

{
  "Value": {
    "PC1": {
      "Default": "",
      "Custom": [],
      "Features": [
        "MOTION"
      ]
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=MachineGroups

Copy and paste into a browser to run - ⚠️ Executes immediately

MachineOutputtingKey [GET]

MachineOutputtingKey

Determines which machines are outputting keyed video based on chromakey settings.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MachineOutputtingKey

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachineOutputtingKey",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachineOutputtingKey"
}

JSON

{
  "Value": {
    "PC1": {
      "OutputKey": false,
      "OutputKeyVisualizeExtremes": false
    },
    "PC2": {
      "OutputKey": false,
      "OutputKeyVisualizeExtremes": false
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=MachineOutputtingKey

Copy and paste into a browser to run - ⚠️ Executes immediately

NetworkAdapters [GET]

NetworkAdapters

Aggregates network adapter information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get NetworkAdapters

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "NetworkAdapters",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "NetworkAdapters"
}

JSON

{
  "Value": {
    "PC1-Daemon": [
      {
        "Name": "localhost",
        "Description": "",
        "Address": "127.0.0.1",
        "Netmask": "",
        "IsPTPInterface": false,
        "isMatroxIface": false
      },
      {
        "Name": "Ethernet",
        "Description": "Realtek Gaming 2.5GbE Family Controller",
        "Address": "192.168.0.10",
        "Netmask": "255.255.255.0",
        "IsPTPInterface": false,
        "isMatroxIface": false
      },
      {
        "Name": "vEthernet (Default Switch)",
        "Description": "vEthernet (Default Switch)",
        "Address": "172.19.48.1",
        "Netmask": "255.255.240.0",
        "IsPTPInterface": false,
        "isMatroxIface": false
      }
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=NetworkAdapters

Copy and paste into a browser to run - ⚠️ Executes immediately

Presets [GET]

Presets

Returns all presets from the store.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get Presets

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Presets",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Presets"
}

JSON

{
  "Value": {
    "VideoKeyer": {
      "Items": {},
      "LastApplied": {}
    },
    "XR": {
      "Items": {},
      "LastApplied": null
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=Presets

Copy and paste into a browser to run - ⚠️ Executes immediately

ProjectsInfos [GET]

ProjectsInfos

Aggregates project paths, projects, and favourite shows from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ProjectsInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ProjectsInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ProjectsInfos"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "Paths": {
        "InstallDirectory": "C:\\Pixotope\\26.3.0.27355",
        "InstallRoot": "C:\\Pixotope",
        "SyncedConfigDirectory": "C:\\Pixotope\\26.3.0.27355\\Synced Config",
        "SyncedStorageDirectory": "C:\\Pixotope\\Synced Storage"
      },
      "Projects": {
        "Paths": [
          {
            "path": "C:\\Pixotope\\26.3.0.27355\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject",
            "name": "PixotopeCalibration",
            "storePath": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject",
            "directory": "C:\\Pixotope\\26.3.0.27355\\Pixotope Engine\\Projects\\PixotopeCalibration"
          }
        ],
        "UseLocalOverride": false,
        "StoreProjects": [
          "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject"
        ],
        "Projects": [
          {
            "directory": "C:\\Pixotope\\26.3.0.27355\\Pixotope Engine\\Projects\\PixotopeCalibration",
            "storePath": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject",
            "storeDirectory": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration",
            "location": "C:\\Pixotope\\26.3.0.27355\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject"
          }
        ],
        "CommonControlPanels": [
          {
            "location": "C:\\Pixotope\\26.3.0.27355\\Local Storage\\Control Panels\\PX - Change color profile.pxpanel",
            "storePath": "C:\\Pixotope\\26.3.0.27355\\Local Storage\\Control Panels\\PX - Change color profile.pxpanel",
            "favorite": false,
            "tags": [
              "Control panel"
            ]
          },
          {
            "location": "C:\\Pixotope\\26.3.0.27355\\Local Storage\\Control Panels\\PX - Change input sources.pxpanel",
            "storePath": "C:\\Pixotope\\26.3.0.27355\\Local Storage\\Control Panels\\PX - Change input sources.pxpanel",
            "favorite": false,
            "tags": [
              "Control panel"
            ]
          }
        ]
      },
      "FavouriteShows": {
        "Shows": [],
        "Levels": [],
        "FavoritesFilter": false,
        "FavoritesLevelFilter": false
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ProjectsInfos

Copy and paste into a browser to run - ⚠️ Executes immediately

TimecodeReport [GET]

TimecodeReport

Generates timecode report from engine system information.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get TimecodeReport

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "TimecodeReport",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "TimecodeReport"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=TimecodeReport

Copy and paste into a browser to run - ⚠️ Executes immediately

TotalDataSources [GET]

TotalDataSources

Returns count of total data sources in the data mapper.

No parameters — message is always {}.

Value

Count

STRING

The count.

Example - Get TotalDataSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "TotalDataSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "TotalDataSources"
}

JSON

{
  "Value": {
    "Count": 1
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=TotalDataSources

Copy and paste into a browser to run - ⚠️ Executes immediately

ColorMatchingInProgress [GET]

ColorMatchingInProgress

Checks if any color matching operation is currently in progress.

No parameters — message is always {}.

Value

InProgress

STRING

The in progress.

Example - Get ColorMatchingInProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingInProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingInProgress"
}

JSON

{
  "Value": {
    "InProgress": false
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ColorMatchingInProgress

Copy and paste into a browser to run - ⚠️ Executes immediately

ColorMatchingProfiles [GET]

ColorMatchingProfiles

Retrieves available color matching profiles from AR/XR pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ColorMatchingProfiles

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingProfiles",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingProfiles"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ColorMatchingProfiles

Copy and paste into a browser to run - ⚠️ Executes immediately

ColorMatchingProgress [GET]

ColorMatchingProgress

Tracks the progress percentage of ongoing color matching operations.

No parameters — message is always {}.

Value

Progress

STRING

The progress.

Example - Get ColorMatchingProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingProgress"
}

JSON

{
  "Value": {
    "Progress": 0
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ColorMatchingProgress

Copy and paste into a browser to run - ⚠️ Executes immediately

ColorMatchingStatuses [GET]

ColorMatchingStatuses

Aggregates color matching calibration status, progress, and state for all pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ColorMatchingStatuses

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ColorMatchingStatuses",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ColorMatchingStatuses"
}

JSON

{
  "Value": {
    "PC1": {
      "Status": 0,
      "InProgress": false,
      "State": "Inactive"
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ColorMatchingStatuses

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedBackupHandler [GET]

ConnectedBackupHandler

Returns connected BackupHandler service.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get ConnectedBackupHandler

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedBackupHandler",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedBackupHandler"
}

JSON

{
  "Value": ""
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedBackupHandler

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedClientMachines [GET]

ConnectedClientMachines

Returns list of connected client machines (non-server machines).

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedClientMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedClientMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedClientMachines"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedClientMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedCTS [GET]

ConnectedCTS

Returns list of connected CTS (Camera Tracking System) services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedCTS

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedCTS",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedCTS"
}

JSON

{
  "Value": [
    "PC1-CTS"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedCTS

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedDaemons [GET]

ConnectedDaemons

Returns list of connected Daemon services.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedDaemons

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedDaemons",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedDaemons"
}

JSON

{
  "Value": [
    "PC1-Daemon"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedDaemons

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedDiagnostics [GET]

ConnectedDiagnostics

Returns list of connected Diagnostics services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedDiagnostics

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedDiagnostics",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedDiagnostics"
}

JSON

{
  "Value": [
    "PC1-Diagnostics"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedDiagnostics

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedDirectors [GET]

ConnectedDirectors

Returns list of connected Director services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedDirectors

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedDirectors",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedDirectors"
}

JSON

{
  "Value": [
    "PC1-Director"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedDirectors

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedEngines [GET]

ConnectedEngines

Returns list of connected Engine services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedEngines"
}

JSON

{
  "Value": [
    "PC1-Engine"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedEngines

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedGateways [GET]

ConnectedGateways

Returns list of connected Gateway services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedGateways

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedGateways",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedGateways"
}

JSON

{
  "Value": [
    "PC1-Gateway"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedGateways

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedLicenseDRMs [GET]

ConnectedLicenseDRMs

Returns list of connected License DRM services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedLicenseDRMs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedLicenseDRMs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedLicenseDRMs"
}

JSON

{
  "Value": [
    "PC1-License"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedLicenseDRMs

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedMachines [GET]

ConnectedMachines

Returns list of machine names extracted from connected daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedMachines"
}

JSON

{
  "Value": [
    "PC1"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedPipelines [GET]

ConnectedPipelines

Returns list of connected Pipeline services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedPipelines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedPipelines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedPipelines"
}

JSON

{
  "Value": [
    "PC1-Pipeline"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedPipelines

Copy and paste into a browser to run - ⚠️ Executes immediately

ConnectedZones [GET]

ConnectedZones

Returns list of connected ZoneTracking services filtered by running daemons.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ConnectedZones

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ConnectedZones",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ConnectedZones"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ConnectedZones

Copy and paste into a browser to run - ⚠️ Executes immediately

CurrentDaemon [GET]

CurrentDaemon

Returns the daemon service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentDaemon

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentDaemon",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentDaemon"
}

JSON

{
  "Value": "PC1-Daemon"
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CurrentDaemon

Copy and paste into a browser to run - ⚠️ Executes immediately

CurrentDirector [GET]

CurrentDirector

Returns the director service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentDirector

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentDirector",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentDirector"
}

JSON

{
  "Value": "PC1-Director"
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CurrentDirector

Copy and paste into a browser to run - ⚠️ Executes immediately

CurrentGateway [GET]

CurrentGateway

Returns the gateway service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentGateway

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentGateway",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentGateway"
}

JSON

{
  "Value": "PC1-Gateway"
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CurrentGateway

Copy and paste into a browser to run - ⚠️ Executes immediately

CurrentLicenseDRM [GET]

CurrentLicenseDRM

Returns the license DRM service of the current machine.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get CurrentLicenseDRM

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentLicenseDRM",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentLicenseDRM"
}

JSON

{
  "Value": "PC1-License"
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CurrentLicenseDRM

Copy and paste into a browser to run - ⚠️ Executes immediately

CurrentMachineTools [GET]

CurrentMachineTools

Returns available tools from the current machine.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get CurrentMachineTools

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CurrentMachineTools",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CurrentMachineTools"
}

JSON

{
  "Value": [
    "ADDITIONAL_OUTPUT_1",
    "ADDITIONAL_OUTPUT_2",
    "ADDITIONAL_OUTPUT_3",
    "AIDEPTH",
    "AIKEYER",
    "AINORMALS",
    "AR",
    "CAMERATRACKINGPLUGIN",
    "CAMERATRACKINGSERVER",
    "CG",
    "CHROMAKEYER",
    "DATAHUB",
    "DATAMAPPER",
    "DUALCAMERAS",
    "EDITOR",
    "ERIZOS_PLUGINS",
    "FIXEDLENSCALIBRATION",
    "GHOSTRIGGER",
    "LARGE_NETWORK",
    "LIVECONTROLLER",
    "LIVINGPHOTO",
    "LIVINGPHOTO_GENERATOR",
    "MANY_CAMERAS",
    "MARKERPATTERNGENERATOR",
    "MATROX",
    "OFFSETCALCULATOR",
    "RIVERMAX",
    "SDI_AUDIO_DEEMBEDDER",
    "SDI_AUDIO_EMBEDDER",
    "SDK",
    "STUDIOCREATOR",
    "SURVEYOR",
    "TALENTRACKCLIENT",
    "TALENTRACKFRONT",
    "TALENTRACKSERVER",
    "TEXT3D",
    "THIRD_PARTY_TRACKING",
    "TORQTRACKBOX",
    "TTL_TRACKING",
    "VIDEOIO",
    "VIOCHIEF",
    "VIOWORKER",
    "VS",
    "XR",
    "ZONE_TRACKING",
    "ZOOMLENSTRACKING",
    "LICENSE_OFFLINE"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CurrentMachineTools

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicCameras [GET]

DynamicCameras

Provides dynamic query data for cameras including name, type, tracking protocol, and camera set.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicCameras

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicCameras",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicCameras"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Id",
      "DisplayName": "Name",
      "Filter": "CameraSet"
    },
    "Items": [],
    "Values": []
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicCameras

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicGroups [GET]

DynamicGroups

Provides dynamic query data for configured machine groups including type, group name, and member machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicGroups"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "GroupName",
      "DisplayName": "GroupName",
      "Filter": [
        "Type",
        "GroupName"
      ]
    },
    "Items": [
      {
        "Type": "Render",
        "GroupName": "MyRenderGroup",
        "MachineNames": [
          "PC1"
        ],
        "MachineNamesString": "[\"PC1\"]"
      }
    ],
    "Values": [
      "Type",
      "GroupName",
      "MachineNames",
      "MachineNamesString"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicGroups

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicIOBotEntities [GET]

DynamicIOBotEntities

Provides dynamic query data for Pixotope Space IOBot entities.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicIOBotEntities

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicIOBotEntities",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicIOBotEntities"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Id",
      "DisplayName": "Name",
      "Filter": "IOType"
    },
    "Items": [],
    "Values": []
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicIOBotEntities

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicIOBotPresets [GET]

DynamicIOBotPresets

Provides dynamic query data for Pixotope Space IOBot presets grouped by entity.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicIOBotPresets

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicIOBotPresets",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicIOBotPresets"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Id",
      "DisplayName": "Name",
      "Filter": "EntityId"
    },
    "Items": [],
    "Values": []
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicIOBotPresets

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicLevels [GET]

DynamicLevels

Provides dynamic query data for available levels across all projects.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicLevels

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicLevels",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicLevels"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Path",
      "DisplayName": "Name",
      "Filter": "ProjectName"
    },
    "Items": [
      {
        "Name": "NewMap",
        "Path": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\Content\\NewMap.umap",
        "ProjectName": "PixotopeCalibration",
        "ProjectPath": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject"
      },
      {
        "Name": "Empty",
        "Path": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\Content\\PixotopeCalibration\\Maps\\Empty.umap",
        "ProjectName": "PixotopeCalibration",
        "ProjectPath": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject"
      }
    ],
    "Values": [
      "Name",
      "Path"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicLevels

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicMachines [GET]

DynamicMachines

Provides dynamic query data for machines including hostname, name, IP, color, render group, and server status.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicMachines"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Hostname",
      "DisplayName": "Name",
      "Filter": "RenderGroup"
    },
    "Items": [
      {
        "Hostname": "PC1",
        "Name": "PC1",
        "IPAddress": "192.168.0.10",
        "Color": "#E65C87",
        "RenderGroup": "",
        "IsServer": true
      }
    ],
    "Values": [
      "Hostname",
      "Name",
      "IPAddress",
      "Color",
      "RenderGroup",
      "IsServer"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicNDISources [GET]

DynamicNDISources

Provides dynamic query data for available NDI sources from all pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicNDISources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicNDISources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicNDISources"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Name",
      "DisplayName": "Name",
      "Filter": "Name"
    },
    "Items": [
      {
        "Name": "PC1 (Output 1)"
      },
      {
        "Name": "PC1 (Remote Connection 1)"
      }
    ],
    "Values": [
      "Name"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicNDISources

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicProjects [GET]

DynamicProjects

Provides dynamic query data for available projects across all machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicProjects

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicProjects",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicProjects"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "ProjectPath",
      "DisplayName": "Name",
      "Filter": "Name"
    },
    "Items": [
      {
        "Name": "PixotopeCalibration",
        "ProjectPath": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject"
      }
    ],
    "Values": [
      "Name",
      "ProjectPath"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicProjects

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicVideoInputs [GET]

DynamicVideoInputs

Provides dynamic query data for video input routing items.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicVideoInputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicVideoInputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicVideoInputs"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Id",
      "DisplayName": "Name",
      "Filter": "MachineName"
    },
    "Items": [],
    "Values": []
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicVideoInputs

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicVideoOutputs [GET]

DynamicVideoOutputs

Provides dynamic query data for video output routing items.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicVideoOutputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicVideoOutputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicVideoOutputs"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Id",
      "DisplayName": "Name",
      "Filter": "MachineName"
    },
    "Items": [
      {
        "Id": "cf356a1b-57ac-4615-8413-73e5674fc081",
        "Name": "Output 1",
        "MachineName": "PC1",
        "IOType": "Output",
        "InputType": "NDI",
        "VideoFormat": "HD-1080p",
        "Type": "Fill",
        "Video": "Output 1",
        "ColorSpace": "Camera Rec.709",
        "XRMapping": null,
        "XRMappings": {},
        "NodeSocketId": "cf356a1b-57ac-4615-8413-73e5674fc081.source"
      }
    ],
    "Values": [
      "Id",
      "Name",
      "MachineName",
      "IOType",
      "InputType",
      "VideoFormat",
      "Type",
      "Video",
      "ColorSpace",
      "XRMapping",
      "XRMappings",
      "NodeSocketId"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicVideoOutputs

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicVideowallLayouts [GET]

DynamicVideowallLayouts

Provides dynamic query data for the videowall layouts of the active digital twin, including layout id, name, active state and slot count.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicVideowallLayouts

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicVideowallLayouts",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicVideowallLayouts"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "LayoutId",
      "DisplayName": "Name",
      "Filter": "Name"
    },
    "Items": [
      {
        "TwinId": "Default",
        "LayoutId": "F8BF397D8BFE41D59C387F41F641E75F",
        "Name": "3Inputs",
        "IsActive": true,
        "SlotCount": 4
      }
    ],
    "Values": [
      "TwinId",
      "LayoutId",
      "Name",
      "IsActive",
      "SlotCount"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicVideowallLayouts

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicVideowallSlots [GET]

DynamicVideowallSlots

Provides dynamic query data for the videowall slots of the active digital twin, across every layout, ordered by slot order within each layout.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicVideowallSlots

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicVideowallSlots",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicVideowallSlots"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "SlotId",
      "DisplayName": "SlotName",
      "Filter": "LayoutId"
    },
    "Items": [
      {
        "TwinId": "Default",
        "LayoutId": "F8BF397D8BFE41D59C387F41F641E75F",
        "LayoutName": "3Inputs",
        "SlotId": "DAD2561CB1244664837A53857AF429FF",
        "SlotName": "Slot 1",
        "LayoutAndSlotName": "3Inputs > Slot 1",
        "Order": 0,
        "Enabled": true
      }
    ],
    "Values": [
      "TwinId",
      "LayoutId",
      "LayoutName",
      "SlotId",
      "SlotName",
      "LayoutAndSlotName",
      "Order",
      "Enabled"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicVideowallSlots

Copy and paste into a browser to run - ⚠️ Executes immediately

DynamicWebcamSources [GET]

DynamicWebcamSources

Provides dynamic query data for available webcam sources from all pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DynamicWebcamSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DynamicWebcamSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DynamicWebcamSources"
}

JSON

{
  "Value": {
    "Default": {
      "Value": "Name",
      "DisplayName": "Name",
      "Filter": "MachineName"
    },
    "Items": [
      {
        "MachineName": "PC1",
        "Name": "NDI Webcam Video 1"
      },
      {
        "MachineName": "PC1",
        "Name": "NDI Webcam Video 2"
      },
      {
        "MachineName": "PC1",
        "Name": "NDI Webcam Video 3"
      },
      {
        "MachineName": "PC1",
        "Name": "NDI Webcam Video 4"
      },
      {
        "MachineName": "PC1",
        "Name": "Microsoft® LifeCam Studio(TM)"
      },
      {
        "MachineName": "PC1",
        "Name": "OBS Virtual Camera"
      }
    ],
    "Values": [
      "MachineName",
      "Name"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DynamicWebcamSources

Copy and paste into a browser to run - ⚠️ Executes immediately

CombinedEngineWorlds [GET]

CombinedEngineWorlds

Aggregates current world information from all ready engines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedEngineWorlds

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedEngineWorlds",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedEngineWorlds"
}

JSON

{
  "Value": {
    "PC1": {
      "Actors": [],
      "CanRedo": false,
      "CanUndo": false,
      "CurrentLevelPath": "/Game/NewMap",
      "Description": "",
      "IsDirty": false,
      "LevelAssetPath": "C:/Pixotope/26.3.0.27355/Pixotope Engine/Projects/PixotopeCalibration/Content/NewMap.umap",
      "LevelPath": "/Game/NewMap",
      "Name": "NewMap",
      "PossessedPawn": "DefaultPawn_0",
      "PrettyName": "NewMap",
      "ProjectFilePath": "C:/Pixotope/26.3.0.27355/Pixotope Engine/Projects/PixotopeCalibration/PixotopeCalibration.uproject",
      "Tags": [],
      "Type": "Game"
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CombinedEngineWorlds

Copy and paste into a browser to run - ⚠️ Executes immediately

EngineCameraPreviews [GET]

EngineCameraPreviews

Aggregates engine camera preview data from all ready engines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EngineCameraPreviews

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineCameraPreviews",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineCameraPreviews"
}

JSON

{
  "Value": {
    "PC1-Engine": null
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=EngineCameraPreviews

Copy and paste into a browser to run - ⚠️ Executes immediately

EngineOptions [GET]

EngineOptions

Aggregates DLSS availability status for all ready engines.

No parameters — message is always {}.

Value

DLSSAvailable

STRING

The dlssavailable.

Example - Get EngineOptions

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineOptions",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineOptions"
}

JSON

{
  "Value": {
    "PC1": {
      "DLSSAvailable": true
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=EngineOptions

Copy and paste into a browser to run - ⚠️ Executes immediately

EngineStates [GET]

EngineStates

Aggregates engine state including pixel streaming enabled, engine starting, and engine running status for all machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EngineStates

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineStates",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineStates"
}

JSON

{
  "Value": {
    "PC1": {
      "PixelStreamingEnabled": false,
      "EngineIsStarting": false,
      "EngineIsRunning": true
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=EngineStates

Copy and paste into a browser to run - ⚠️ Executes immediately

EnginesVideowallTransitionReady [GET]

EnginesVideowallTransitionReady

Checks if all engines in the XR render group are ready for videowall transition, holding it while any of them is still launching.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EnginesVideowallTransitionReady

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EnginesVideowallTransitionReady",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EnginesVideowallTransitionReady"
}

JSON

{
  "Value": true
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=EnginesVideowallTransitionReady

Copy and paste into a browser to run - ⚠️ Executes immediately

EngineXRFOVs [GET]

EngineXRFOVs

Aggregates the XR field-of-view (EngineXRFOV) reported by every ready engine, keyed by engine.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EngineXRFOVs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EngineXRFOVs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EngineXRFOVs"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=EngineXRFOVs

Copy and paste into a browser to run - ⚠️ Executes immediately

ReadyAndLaunchingEngines [GET]

ReadyAndLaunchingEngines

Splits engines into ready ones and ones still launching, launching covers both the process starting up and a connected engine that is not Ready yet.

No parameters — message is always {}.

Value

Result

OBJECT

Ready and Launching engine lists, plus All for both combined.

Example - Get ReadyAndLaunchingEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ReadyAndLaunchingEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ReadyAndLaunchingEngines"
}

JSON

{
  "Value": {
    "Ready": [
      "PC1-Engine"
    ],
    "Launching": [
      "PC2-Engine",
      "PC3-Engine"
    ],
    "All": [
      "PC1-Engine",
      "PC2-Engine",
      "PC3-Engine"
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ReadyAndLaunchingEngines

Copy and paste into a browser to run - ⚠️ Executes immediately

ReadyEngines [GET]

ReadyEngines

Filters connected engines to return only those that are ready.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get ReadyEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ReadyEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ReadyEngines"
}

JSON

{
  "Value": [
    "PC1-Engine"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ReadyEngines

Copy and paste into a browser to run - ⚠️ Executes immediately

InputSources [GET]

InputSources

Aggregates formatted input sources (NDI, AJA cards, webcams) from all connected pipelines.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get InputSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "InputSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "InputSources"
}

JSON

{
  "Value": {
    "PC1-Pipeline": {
      "NDISources": [
        "PC1 (Output 1)",
        "PC1 (Remote Connection 1)"
      ],
      "AJACards": [],
      "WebcamSources": [
        "NDI Webcam Video 1",
        "NDI Webcam Video 2",
        "NDI Webcam Video 3",
        "NDI Webcam Video 4",
        "Microsoft® LifeCam Studio(TM)",
        "OBS Virtual Camera"
      ]
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=InputSources

Copy and paste into a browser to run - ⚠️ Executes immediately

OutputSources [GET]

OutputSources

Output sources for all connected Pipelines

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get InputSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "OutputSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "OutputSources"
}

{"Value": {"zeebuk-Pipeline": [{ "Name": "Camera 1", Source: "1e38e041-5278-4e55-a819-c998bb51983e", "SubSources": [{ "Name": "Key", "Source": "1e38e041-5278-4e55-a819-c998bb51983e_Key" }], "TypeName": "Webcam"}]}}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=OutputSources

Copy and paste into a browser to run - ⚠️ Executes immediately

RunningPipeline [GET]

RunningPipeline

Returns the currently running pipeline, either current or first connected.

No parameters — message is always {}.

Value

Result

STRING

The result.

Example - Get RunningPipeline

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RunningPipeline",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RunningPipeline"
}

JSON

{
  "Value": "PC1-Pipeline"
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RunningPipeline

Copy and paste into a browser to run - ⚠️ Executes immediately

VideoOptions [GET]

VideoOptions

Retrieves video format options (colorspaces, formats, resolutions, framerates, inputs, outputs) from running pipeline.

No parameters — message is always {}.

Value

Secondary	STRING	The secondary.
ColorspacesCategories	OBJECT	The colorspaces categories.
Colorspaces	OBJECT	The colorspaces full list.
Formats	OBJECT	The formats.
Resolutions	OBJECT	The resolutions.
FrameRates	OBJECT	The frame rates.
Inputs	OBJECT	The inputs types.
Outputs	OBJECT	The outputs types.
FileExtensions	OBJECT	Verbatim relay of the file extensions the File input can decode ({Images, Videos}, dot-less); {} on older backends that don't publish it (CP-3872).

VideoOptions [GET]

VideoOptions

No parameters — message is always {}.

Example - Get VideoOptions

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoOptions",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoOptions"
}

JSON

{
  "Value": {
    "ColorspacesCategories": {
      "Main": [
        "Camera Rec.709",
        "sRGB"
      ],
      "Secondary": [
        "ACES2065-1",
        "ACEScc"
      ]
    },
    "Colorspaces": [
      "ACES2065-1",
      "ACEScc"
    ],
    "Formats": {
      "2K-2048x1080p-23.98": {
        "Framerate": 23.979999542236328,
        "FramerateString": "23.98p",
        "Height": 1080,
        "Index": 26,
        "Interlaced": false,
        "Width": 2048
      },
      "2K-2048x1080p-24": {
        "Framerate": 24,
        "FramerateString": "24p",
        "Height": 1080,
        "Index": 27,
        "Interlaced": false,
        "Width": 2048
      },
      "2K-2048x1080p-25": {
        "Framerate": 25,
        "FramerateString": "25p",
        "Height": 1080,
        "Index": 28,
        "Interlaced": false,
        "Width": 2048
      },
      "2K-2048x1080p-29.97": {
        "Framerate": 29.969999313354492,
        "FramerateString": "29.97p",
        "Height": 1080,
        "Index": 29,
        "Interlaced": false,
        "Width": 2048
      }
    },
    "Resolutions": [
      "HD-720p",
      "HD-1080i"
    ],
    "FrameRates": [
      23.98,
      24
    ],
    "Inputs": [
      {
        "Name": "SDI - AJA",
        "Type": "AJA"
      },
      {
        "Name": "SDI - BMD",
        "Type": "BMD"
      }
    ],
    "Outputs": [
      {
        "Name": "SDI - AJA",
        "Type": "AJA"
      },
      {
        "Name": "SDI - BMD",
        "Type": "BMD"
      }
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideoOptions

Copy and paste into a browser to run - ⚠️ Executes immediately

CameraSystems [GET]

CameraSystems

Calls GetCameraSystems query with machines, cameras, and tracking statuses to aggregate camera system data.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CameraSystems

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CameraSystems",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CameraSystems"
}

JSON

{
  "Value": {
    "PC1": {
      "CameraSystems": [],
      "ZoneCameras": [],
      "TrackingCameras": [],
      "VideoIOInputs": []
    },
    "PC2": {
      "CameraSystems": [],
      "ZoneCameras": [],
      "TrackingCameras": [],
      "VideoIOInputs": []
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CameraSystems

Copy and paste into a browser to run - ⚠️ Executes immediately

VideoInputs [GET]

VideoInputs

Aggregates all video routing items (both inputs and outputs) from all machines.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VideoInputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoInputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoInputs"
}

JSON

{
  "Value": [
    {
      "Id": "cf356a1b-57ac-4615-8413-73e5674fc081",
      "Name": "Output 1",
      "MachineName": "PC1",
      "IOType": "Output",
      "InputType": "NDI",
      "VideoFormat": "HD-1080p",
      "Type": "Fill",
      "Video": "Output 1",
      "ColorSpace": "Camera Rec.709",
      "XRMapping": null,
      "XRMappings": {}
    }
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideoInputs

Copy and paste into a browser to run - ⚠️ Executes immediately

VideoIOInputs [GET]

VideoIOInputs

Filters VideoInputs to return only input-type video routing items.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VideoIOInputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoIOInputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoIOInputs"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideoIOInputs

Copy and paste into a browser to run - ⚠️ Executes immediately

VideoIOOutputs [GET]

VideoIOOutputs

Filters VideoInputs to return only output-type video routing items.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VideoIOOutputs

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoIOOutputs",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoIOOutputs"
}

JSON

{
  "Value": [
    {
      "Id": "cf356a1b-57ac-4615-8413-73e5674fc081",
      "Name": "Output 1",
      "MachineName": "PC1",
      "IOType": "Output",
      "InputType": "NDI",
      "VideoFormat": "HD-1080p",
      "Type": "Fill",
      "Video": "Output 1",
      "ColorSpace": "Camera Rec.709",
      "XRMapping": null,
      "XRMappings": {}
    }
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideoIOOutputs

Copy and paste into a browser to run - ⚠️ Executes immediately

HealthThresholds [GET]

HealthThresholds

Returns configured health thresholds and default threshold values.

No parameters — message is always {}.

Value

Thresholds	STRING	The thresholds.
DefaultThresholds	STRING	The default thresholds.

Example - Get HealthThresholds

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthThresholds",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthThresholds"
}

JSON

{
  "Value": {
    "Thresholds": {
      "CPUFrequency": {
        "warning": 3200,
        "critical": 2700
      },
      "CPUUtilisation": {
        "warning": 50,
        "critical": 60
      },
      "RAMMemoryUsage": {
        "warning": 50,
        "critical": 70
      },
      "GPUFrequency": {
        "warning": 1500,
        "critical": 1000
      },
      "GPUTemperature": {
        "warning": 85,
        "critical": 95
      },
      "GPUUtilisation": {
        "warning": 75,
        "critical": 95
      },
      "GPUMemoryUtilisation": {
        "warning": 80,
        "critical": 90
      }
    },
    "DefaultThresholds": {
      "CPUFrequency": {
        "warning": 3200,
        "critical": 2700
      },
      "CPUUtilisation": {
        "warning": 50,
        "critical": 60
      },
      "RAMMemoryUsage": {
        "warning": 50,
        "critical": 70
      },
      "GPUFrequency": {
        "warning": 1500,
        "critical": 1000
      },
      "GPUTemperature": {
        "warning": 85,
        "critical": 95
      },
      "GPUUtilisation": {
        "warning": 75,
        "critical": 95
      },
      "GPUMemoryUtilisation": {
        "warning": 80,
        "critical": 90
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=HealthThresholds

Copy and paste into a browser to run - ⚠️ Executes immediately

HealthyEngines [GET]

HealthyEngines

Returns list of machines that have healthy engine metrics.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get HealthyEngines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthyEngines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthyEngines"
}

JSON

{
  "Value": [
    "PC1"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=HealthyEngines

Copy and paste into a browser to run - ⚠️ Executes immediately

HealthyMachines [GET]

HealthyMachines

Returns list of unique machine names from connected pipelines.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get HealthyMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthyMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthyMachines"
}

JSON

{
  "Value": [
    "PC1"
  ]
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=HealthyMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

HealthySystemInfo [GET]

HealthySystemInfo

Evaluates machines health to determine if they have critical issues.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get HealthySystemInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "HealthySystemInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "HealthySystemInfo"
}

JSON

{
  "Value": {
    "PC1": {
      "valid": true
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=HealthySystemInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

LOWPRIO_MachinesHealth [GET]

LOWPRIO_MachinesHealth

Processes and aggregates machine health metrics from diagnostics, pipeline, and engine services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get LOWPRIO_MachinesHealth

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "LOWPRIO_MachinesHealth",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "LOWPRIO_MachinesHealth"
}

JSON

{
  "Value": {
    "PC1": {
      "Cpu": {
        "CoreUsage": {
          "Value": 36.222755432128906
        },
        "CoreUsageHealth": {
          "warning": false,
          "critical": false
        },
        "Frequency": {
          "Value": 4452.739539899474
        },
        "FrequencyHealth": {
          "warning": false,
          "critical": false
        }
      },
      "Gpu": {
        "Temperature": {
          "Value": 57
        },
        "CoreUsage": {
          "Value": 50
        },
        "MemoryUsage": {
          "Value": 34.28117141016991
        },
        "TemperatureHealth": {
          "warning": false,
          "critical": false
        }
      },
      "Memory": {
        "MemoryUsage": {
          "Value": 46.84345625057036
        },
        "MemoryUsageHealth": {
          "warning": false,
          "critical": false
        }
      },
      "Engine": {
        "Framerate": 175.53163146972656,
        "TargetFPS": 25,
        "PerformanceOK": true,
        "Timecode": null
      },
      "VideoCard": {
        "Temperature": null
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=LOWPRIO_MachinesHealth

Copy and paste into a browser to run - ⚠️ Executes immediately

ParameterThresholds [GET]

ParameterThresholds

Returns parameter thresholds for machine health monitoring from store.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ParameterThresholds

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ParameterThresholds",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ParameterThresholds"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ParameterThresholds

Copy and paste into a browser to run - ⚠️ Executes immediately

ValidInvalidMachines [GET]

ValidInvalidMachines

Calculates valid and invalid machines based on health metrics and critical failover settings.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ValidInvalidMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ValidInvalidMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ValidInvalidMachines"
}

JSON

{
  "Value": {
    "ValidMachines": [
      "PC1"
    ],
    "InvalidMachines": {},
    "MachinesConnected": true,
    "ValidMachinesPresent": true
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ValidInvalidMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

RenderGroupMachines [GET]

RenderGroupMachines

Aggregates render group machines including host, clients, grouped machines, and available machine names.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderGroupMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderGroupMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderGroupMachines"
}

JSON

{
  "Value": {
    "Clients": [],
    "ClientsWithoutServerBackup": [],
    "AvailableClientNames": [],
    "AvailableAllClientNames": [],
    "BackupMachineNames": [],
    "MainMachineNames": [],
    "GroupedMachines": {},
    "ServerBackupClient": {
      "MachineInfo": {
        "IPAddress": "",
        "Title": ""
      }
    },
    "ServerMainInfo": {
      "Hostname": "",
      "Name": "",
      "IPAddress": "",
      "Version": "",
      "Connected": false
    },
    "Host": {
      "Hostname": "PC1",
      "Connected": true,
      "Diagnostics": true,
      "Routings": [],
      "Active": false,
      "IsBackup": false,
      "IsMain": false,
      "OutOfSync": false,
      "Locked": false,
      "Supported": true,
      "Valid": true,
      "IsBackupClient": false,
      "IsBackupServer": false,
      "IsServerBackupActive": false,
      "IsMainServer": false,
      "MachineInfo": {
        "IPAddress": "",
        "Title": ""
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RenderGroupMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

AllSelectedGroupMachines [GET]

AllSelectedGroupMachines

Returns all selected machines from grouped render machines.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get AllSelectedGroupMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AllSelectedGroupMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AllSelectedGroupMachines"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=AllSelectedGroupMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

GroupedRenderMachines [GET]

GroupedRenderMachines

Groups render machines by machine groups with selected and available machines for main and backup.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get GroupedRenderMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "GroupedRenderMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "GroupedRenderMachines"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=GroupedRenderMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

RenderClientsGroupInfo [GET]

RenderClientsGroupInfo

Combines grouped render machines with detailed machine info for selected and available machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderClientsGroupInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderClientsGroupInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderClientsGroupInfo"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RenderClientsGroupInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

RenderClientsMachineInfo [GET]

RenderClientsMachineInfo

Aggregates render client machine information including color and machine group memberships.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderClientsMachineInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderClientsMachineInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderClientsMachineInfo"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RenderClientsMachineInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

RenderMachineGroups [GET]

RenderMachineGroups

Processes render machine groups by filtering routing lengths and checking for out-of-sync states.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderMachineGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderMachineGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderMachineGroups"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RenderMachineGroups

Copy and paste into a browser to run - ⚠️ Executes immediately

ValidRenderMachineGroups [GET]

ValidRenderMachineGroups

Filters and returns valid render machine groups based on connected machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ValidRenderMachineGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ValidRenderMachineGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ValidRenderMachineGroups"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ValidRenderMachineGroups

Copy and paste into a browser to run - ⚠️ Executes immediately

ActivatedBackupMachines [GET]

ActivatedBackupMachines

Manages automatic failover by activating backup machines when main machines become unhealthy.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get ActivatedBackupMachines

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ActivatedBackupMachines",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ActivatedBackupMachines"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ActivatedBackupMachines

Copy and paste into a browser to run - ⚠️ Executes immediately

AutomaticFailover [GET]

AutomaticFailover

Returns the automatic failover setting from the store.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get AutomaticFailover

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AutomaticFailover",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AutomaticFailover"
}

JSON

{
  "Value": true
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=AutomaticFailover

Copy and paste into a browser to run - ⚠️ Executes immediately

FailoverController [GET]

FailoverController

Controls failover process by activating backup machines and updating machine groups and XR mappings.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get FailoverController

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "FailoverController",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "FailoverController"
}

JSON

{
  "Value": true
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=FailoverController

Copy and paste into a browser to run - ⚠️ Executes immediately

VidehubUpdates [GET]

VidehubUpdates

Generates Videohub routing updates for failover scenarios and out-of-sync corrections.

No parameters — message is always {}.

Value

Result

OBJECT[]

The result.

Example - Get VidehubUpdates

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VidehubUpdates",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VidehubUpdates"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VidehubUpdates

Copy and paste into a browser to run - ⚠️ Executes immediately

VideohubController [GET]

VideohubController

Syncs Videohub routings when automatic failover is enabled and Videohub is connected.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get VideohubController

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubController",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubController"
}

JSON

{
  "Value": true
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideohubController

Copy and paste into a browser to run - ⚠️ Executes immediately

RenderClientsMappingInfo [GET]

RenderClientsMappingInfo

Aggregates render client mapping information for main and backup machines in each group.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get RenderClientsMappingInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderClientsMappingInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderClientsMappingInfo"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RenderClientsMappingInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

RenderMappingUsedSources [GET]

RenderMappingUsedSources

Returns all used videohub sources and destinations from render machine groups.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get RenderMappingUsedSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "RenderMappingUsedSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "RenderMappingUsedSources"
}

JSON

{
  "Value": {
    "Sources": [],
    "Destinations": []
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=RenderMappingUsedSources

Copy and paste into a browser to run - ⚠️ Executes immediately

ResetMachinesGroupsMapping [GET]

ResetMachinesGroupsMapping

Resets machine group routings based on video outputs and connected machines.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get ResetMachinesGroupsMapping

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ResetMachinesGroupsMapping",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ResetMachinesGroupsMapping"
}

JSON

{
  "Value": true
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ResetMachinesGroupsMapping

Copy and paste into a browser to run - ⚠️ Executes immediately

VideohubSources [GET]

VideohubSources

Returns Videohub input/output sources and their state including routing and lock status.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideohubSources

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubSources",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubSources"
}

JSON

{
  "Value": {
    "Outputs": [],
    "Inputs": [],
    "OutputState": {}
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideohubSources

Copy and paste into a browser to run - ⚠️ Executes immediately

VideohubState [GET]

VideohubState

Returns Videohub state including input/output labels, locks, and routing from current daemon.

No parameters — message is always {}.

Value

InputLabels

STRING

The input labels.

Example - Get VideohubState

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubState",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubState"
}

JSON

{
  "Value": {
    "InputLabels": {},
    "OutputLabels": {},
    "VideoOutputLocks": {},
    "VideoOutputRouting": {}
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideohubState

Copy and paste into a browser to run - ⚠️ Executes immediately

VideoOutputsPerMachine [GET]

VideoOutputsPerMachine

Aggregates video outputs grouped by machine name.

No parameters — message is always {}.

Value

Result

STRING[]

The result.

Example - Get VideoOutputsPerMachine

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoOutputsPerMachine",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoOutputsPerMachine"
}

JSON

{
  "Value": {
    "PC1": [
      {
        "Name": "Output 1",
        "VideoFormat": "HD-1080p",
        "OutputDestination": "Output 1"
      }
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideoOutputsPerMachine

Copy and paste into a browser to run - ⚠️ Executes immediately

ActiveBackupServer [GET]

ActiveBackupServer

Returns active server, whether it is main or backup.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ActiveBackupServer

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ActiveBackupServer",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ActiveBackupServer"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ActiveBackupServer

Copy and paste into a browser to run - ⚠️ Executes immediately

AvailableServerBackups [GET]

AvailableServerBackups

Filters and aggregates available server backup machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableServerBackups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableServerBackups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableServerBackups"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=AvailableServerBackups

Copy and paste into a browser to run - ⚠️ Executes immediately

BackupMachineLoaders [GET]

BackupMachineLoaders

Returns the loaders per machine.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get BackupMachineLoaders

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "BackupMachineLoaders",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "BackupMachineLoaders"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "BuckupInfoUpdateInProgress": false,
      "BackupClientUpdated": false
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=BackupMachineLoaders

Copy and paste into a browser to run - ⚠️ Executes immediately

BackupNetworkStatus [GET]

BackupNetworkStatus

Returns the network status of the server backup.

No parameters — message is always {}.

Value

Healthy	STRING	The healthy.
Configured	STRING	The configured.
UnhealthyReasons	STRING	The unhealthy reasons.
BackupMachineDisconnected	STRING	The backup machine disconnected.

Example - Get BackupNetworkStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "BackupNetworkStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "BackupNetworkStatus"
}

JSON

{
  "Value": {
    "Healthy": false,
    "Configured": false,
    "UnhealthyReasons": [
      "Backup network is not set, not all clients are disconnected (PC1)",
      "No backup machine is connected to backup network",
      "There are multiple selected backup machines (PC2)"
    ],
    "BackupMachineDisconnected": true
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=BackupNetworkStatus

Copy and paste into a browser to run - ⚠️ Executes immediately

EnabledBackupClient [GET]

EnabledBackupClient

Returns the enabled backup client info.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get EnabledBackupClient

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "EnabledBackupClient",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "EnabledBackupClient"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=EnabledBackupClient

Copy and paste into a browser to run - ⚠️ Executes immediately

MainServerInfo [GET]

MainServerInfo

Returns the main server idle info.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get MainServerInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MainServerInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MainServerInfo"
}

JSON

{
  "Value": {
    "Hostname": "",
    "Name": "",
    "IPAddress": "",
    "Version": "",
    "Connected": false
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=MainServerInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

ServerBackupClients [GET]

ServerBackupClients

Filters and aggregates server backup client information with daemon details.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ServerBackupClients

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackupClients",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackupClients"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ServerBackupClients

Copy and paste into a browser to run - ⚠️ Executes immediately

ServerBackupInProgress [GET]

ServerBackupInProgress

Returns the loading status, backup handler loaders, and backup machine loaders.

No parameters — message is always {}.

Value

Loading	STRING	The loading.
BackupMachineLoaders	STRING	The backup machine loaders.

Example - Get ServerBackupInProgress

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackupInProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackupInProgress"
}

JSON

{
  "Value": {
    "Loading": false,
    "BackupMachineLoaders": {
      "PC1-Daemon": {
        "BuckupInfoUpdateInProgress": false,
        "BackupClientUpdated": false
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ServerBackupInProgress

Copy and paste into a browser to run - ⚠️ Executes immediately

ServerBackups [GET]

ServerBackups

Aggregates server backup information for all client machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ServerBackups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackups"
}

JSON

{
  "Value": {
    "PC1": {
      "Enabled": false,
      "IsClient": false,
      "Licensed": false,
      "Active": false,
      "IsMainServer": false,
      "IsBackupServer": false,
      "IsBackupClient": false,
      "BackupClientIPAddress": ""
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ServerBackups

Copy and paste into a browser to run - ⚠️ Executes immediately

ServerBackupsInfo [GET]

ServerBackupsInfo

Aggregates server backup information for all client machines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get ServerBackupsInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ServerBackupsInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ServerBackupsInfo"
}

JSON

{
  "Value": {
    "PC1": {
      "Enabled": false,
      "IsClient": false,
      "Licensed": false,
      "Active": false,
      "IsMainServer": false,
      "IsBackupServer": false,
      "IsBackupClient": false,
      "BackupClientIPAddress": "",
      "IPAddress": "192.168.0.10",
      "Hostname": "PC1",
      "Title": "PC1"
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ServerBackupsInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

VideohubAutoConnect [GET]

VideohubAutoConnect

Manages Videohub auto-connect by connecting or disconnecting based on stored settings.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get VideohubAutoConnect

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubAutoConnect",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubAutoConnect"
}

JSON

{
  "Value": false
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideohubAutoConnect

Copy and paste into a browser to run - ⚠️ Executes immediately

VideohubConnectionInfo [GET]

VideohubConnectionInfo

Returns Videohub connection information including auto-connect setting and IP address.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideohubConnectionInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubConnectionInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubConnectionInfo"
}

JSON

{
  "Value": {
    "AutoConnect": false,
    "IPAddress": ""
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideohubConnectionInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

VideohubConnectionStatus [GET]

VideohubConnectionStatus

Returns Videohub server connection status from the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideohubConnectionStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideohubConnectionStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideohubConnectionStatus"
}

JSON

{
  "Value": {
    "IsConnected": false,
    "IP": "",
    "Port": -1
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideohubConnectionStatus

Copy and paste into a browser to run - ⚠️ Executes immediately

CustomDirectors [GET]

CustomDirectors

Aggregates custom director information (name, color, title) for all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CustomDirectors

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CustomDirectors",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CustomDirectors"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "Name": "",
      "Color": "",
      "Title": "PC1",
      "DefaultColor": "#E65C87",
      "UseDefaultColor": true,
      "DoNotUseColor": false
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CustomDirectors

Copy and paste into a browser to run - ⚠️ Executes immediately

DaemonInfos [GET]

DaemonInfos

Aggregates daemon information including machine info, meta info, custom directors, and network details.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DaemonInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonInfos"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "Info": {
        "service": "PC1-Daemon",
        "hostname": "PC1",
        "version": "26.3.0.27355"
      },
      "MetaInfo": {
        "IPAddress": "192.168.0.10",
        "MachineInfo": {
          "service": "PC1-Daemon",
          "hostname": "PC1",
          "version": "26.3.0.27355"
        }
      },
      "CustomDirector": {
        "Name": "",
        "Color": "",
        "Title": "PC1",
        "DefaultColor": "#E65C87",
        "UseDefaultColor": true,
        "DoNotUseColor": false
      },
      "NetworkAccessibleIp": "192.168.0.10",
      "UseDefaultColor": true,
      "DoNotUseColor": false
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DaemonInfos

Copy and paste into a browser to run - ⚠️ Executes immediately

DaemonIsBusy [GET]

DaemonIsBusy

Aggregates daemon is busy information from all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DaemonIsBusy

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonIsBusy",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonIsBusy"
}

JSON

{
  "Value": {
    "PC1-Daemon": false
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DaemonIsBusy

Copy and paste into a browser to run - ⚠️ Executes immediately

DaemonProjects [GET]

DaemonProjects

Aggregates storePath and location for each project from all connected daemons, keyed by daemon name.

No parameters — message is always {}.

Value

Result

OBJECT

Map of daemon name to array of {storePath, location} objects.

Example - Get DaemonProjects

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DaemonProjects",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DaemonProjects"
}

JSON

{
  "Value": {
    "PC1-Daemon": [
      {
        "storePath": "%APPLICATION%\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject",
        "location": "C:\\Pixotope\\26.3.0.27355\\Pixotope Engine\\Projects\\PixotopeCalibration\\PixotopeCalibration.uproject"
      }
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DaemonProjects

Copy and paste into a browser to run - ⚠️ Executes immediately

DaemonRoles [GET]

DaemonRoles

Aggregates role information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get Roles

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Roles",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Roles"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "Role": "SERVER"
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=Roles

Copy and paste into a browser to run - ⚠️ Executes immediately

DirectorInfos [GET]

DirectorInfos

Aggregates director startup information from all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get DirectorInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "DirectorInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "DirectorInfos"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "Startup": false,
      "Mismatch": false,
      "Version": "",
      "Path": ""
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=DirectorInfos

Copy and paste into a browser to run - ⚠️ Executes immediately

InstallerInfos [GET]

InstallerInfos

Aggregates installer type information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get InstallerInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "InstallerInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "InstallerInfos"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "InstallerType": "Full"
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=InstallerInfos

Copy and paste into a browser to run - ⚠️ Executes immediately

LicenseInfos [GET]

LicenseInfos

Aggregates license information including user email and activated license names from DRM servers.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get LicenseInfos

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "LicenseInfos",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "LicenseInfos"
}

JSON

{
  "Value": {
    "PC1-License": {
      "Email": "user@example.com",
      "ActivatedLicenseNames": [
        "Everything (Internal) | Everything (Internal)"
      ]
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=LicenseInfos

Copy and paste into a browser to run - ⚠️ Executes immediately

PathsInfo [GET]

PathsInfo

Aggregates path information (machine paths and synced paths) from all daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PathsInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PathsInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PathsInfo"
}

JSON

{
  "Value": {
    "MachinePaths": {
      "PC1": {
        "InstallDirectory": "C:\\Pixotope\\26.3.0.27355",
        "InstallRoot": "C:\\Pixotope",
        "SyncedConfigDirectory": "C:\\Pixotope\\26.3.0.27355\\Synced Config",
        "SyncedStorageDirectory": "C:\\Pixotope\\Synced Storage"
      }
    },
    "SyncedPaths": {
      "SyncedStorage": {
        "Expression": "%SYNCED_STORAGE%",
        "PathName": "SyncedStorageDirectory"
      },
      "SyncedConfig": {
        "Expression": "%SYNCED_CONFIG%",
        "PathName": "SyncedConfigDirectory"
      },
      "Application": {
        "Expression": "%APPLICATION%",
        "PathName": "InstallDirectory"
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PathsInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

PixotopeVersions [GET]

PixotopeVersions

Aggregates Pixotope version information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeVersions

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeVersions",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeVersions"
}

JSON

{
  "Value": {
    "PC1-Daemon": "26.3.0.27355"
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PixotopeVersions

Copy and paste into a browser to run - ⚠️ Executes immediately

Roles [GET]

Roles

Aggregates role information from all connected daemons.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get Roles

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Roles",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Roles"
}

JSON

{
  "Value": {
    "PC1-Daemon": {
      "Role": "SERVER"
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=Roles

Copy and paste into a browser to run - ⚠️ Executes immediately

CombinedNMOSConfig [GET]

CombinedNMOSConfig

Aggregates NMOS persistent state configuration from all connected Matrox services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedNMOSConfig

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedNMOSConfig",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedNMOSConfig"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CombinedNMOSConfig

Copy and paste into a browser to run - ⚠️ Executes immediately

CombinedNMOSConnStatus [GET]

CombinedNMOSConnStatus

Aggregates NMOS connection status from all connected Matrox services.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CombinedNMOSConnStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CombinedNMOSConnStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CombinedNMOSConnStatus"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CombinedNMOSConnStatus

Copy and paste into a browser to run - ⚠️ Executes immediately

MachineFeatures [GET]

MachineFeatures

Returns feature support flags for each machine.

No parameters — message is always {}.

Value

Result	OBJECT	Map of machine name to supported feature flags.
SupportXRRenderGroup	BOOLEAN	Per-machine support for XR render groups.
SupportVSRenderGroup	BOOLEAN	Per-machine support for VS render groups.
SupportARRenderGroup	BOOLEAN	Per-machine support for AR render groups.
SupportARVSRenderGroup	BOOLEAN	Per-machine support for AR/VS render groups.
SupportVideoIO	BOOLEAN	Per-machine support for Video IO.
SupportEditor	BOOLEAN	Per-machine support for Editor.
SupportsConfiguration	BOOLEAN	Per-machine support for configuration.
SupportCameraTracking	BOOLEAN	Per-machine support for Camera Tracking Server.
SupportAIDepthKeyer	BOOLEAN	Per-machine support for AI depth keyer.
SupportAINormals	BOOLEAN	Per-machine support for AI normals.
SupportVioSportKeyer	BOOLEAN	Per-machine support for VIO sport keyer.
SupportZoneTracking	BOOLEAN	Per-machine support for zone tracking.

Example - Get MachineFeatures

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "MachineFeatures",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "MachineFeatures"
}

JSON

{
  "Value": {
    "PC1": {
      "SupportXRRenderGroup": true,
      "SupportVSRenderGroup": true,
      "SupportARRenderGroup": true,
      "SupportARVSRenderGroup": true,
      "SupportVideoIO": true,
      "SupportEditor": true,
      "SupportsConfiguration": true,
      "SupportCameraTracking": true,
      "SupportAIKeyer": true,
      "SupportAIDepthKeyer": true,
      "SupportAINormals": true,
      "SupportVioSportKeyer": false,
      "SupportZoneTracking": true
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=MachineFeatures

Copy and paste into a browser to run - ⚠️ Executes immediately

ManageNetworkGroups [GET]

ManageNetworkGroups

Manages Pixotope Network client groups by updating server group info.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get ManageNetworkGroups

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ManageNetworkGroups",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ManageNetworkGroups"
}

JSON

{
  "Value": false
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ManageNetworkGroups

Copy and paste into a browser to run - ⚠️ Executes immediately

NetworkFeatures [GET]

NetworkFeatures

Returns network features supported by the server machine.

No parameters — message is always {}.

Value

SupportLargeNetwork	STRING	The support large network.
SupportManyCameras	STRING	The support many cameras.
SupportThirdPartyTracking	STRING	The support third party tracking.
EnginePresent	STRING	The engine present.
DualCamerasPresent	STRING	The dual cameras present.
XRPresent	STRING	The xrpresent.
ChromaKeyerPresent	STRING	The chroma keyer present.
SupportDatamapper	STRING	The support datamapper.

Example - Get NetworkFeatures

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "NetworkFeatures",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "NetworkFeatures"
}

JSON

{
  "Value": {
    "SupportLargeNetwork": true,
    "SupportManyCameras": true,
    "SupportThirdPartyTracking": true,
    "EnginePresent": true,
    "DualCamerasPresent": true,
    "XRPresent": true,
    "ChromaKeyerPresent": true,
    "SupportDatamapper": true
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=NetworkFeatures

Copy and paste into a browser to run - ⚠️ Executes immediately

ManageIOBotConnection [GET]

ManageIOBotConnection

Manages IOBot connection/disconnection based on stored connection info.

No parameters — message is always {}.

Value

Result

BOOLEAN

The result.

Example - Get ManageIOBotConnection

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ManageIOBotConnection",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ManageIOBotConnection"
}

JSON

{
  "Value": true
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ManageIOBotConnection

Copy and paste into a browser to run - ⚠️ Executes immediately

PixotopeSpaceConnectiomStatus [GET]

PixotopeSpaceConnectiomStatus

Returns IOBot connection status for the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeSpaceConnectiomStatus

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpaceConnectiomStatus",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpaceConnectiomStatus"
}

JSON

{
  "Value": {
    "IsConnected": false,
    "IPAddress": "",
    "Port": 0
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PixotopeSpaceConnectiomStatus

Copy and paste into a browser to run - ⚠️ Executes immediately

PixotopeSpaceConnectionInfo [GET]

PixotopeSpaceConnectionInfo

Returns stored Pixotope Space IOBot connection information (IP and port).

No parameters — message is always {}.

Value

IPAddress	STRING	The ipaddress.
Port	STRING	The port.

Example - Get PixotopeSpaceConnectionInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpaceConnectionInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpaceConnectionInfo"
}

JSON

{
  "Value": {
    "IPAddress": "",
    "Port": 8000
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PixotopeSpaceConnectionInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

PixotopeSpaceEntities [GET]

PixotopeSpaceEntities

Returns IOBot entities from the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeSpaceEntities

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpaceEntities",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpaceEntities"
}

JSON

{
  "Value": []
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PixotopeSpaceEntities

Copy and paste into a browser to run - ⚠️ Executes immediately

PixotopeSpacePresets [GET]

PixotopeSpacePresets

Returns IOBot presets grouped by entity from the current daemon.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PixotopeSpacePresets

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PixotopeSpacePresets",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PixotopeSpacePresets"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PixotopeSpacePresets

Copy and paste into a browser to run - ⚠️ Executes immediately

AvailableSRTPorts [GET]

AvailableSRTPorts

Calculates available SRT ports for each machine based on used ports in Routing.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableSRTPorts

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableSRTPorts",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableSRTPorts"
}

JSON

{
  "Value": {
    "PC1": {
      "UsedPorts": [],
      "AvailablePort": 16231
    },
    "PC2": {
      "UsedPorts": [],
      "AvailablePort": 16231
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=AvailableSRTPorts

Copy and paste into a browser to run - ⚠️ Executes immediately

AvailableUDPPorts [GET]

AvailableUDPPorts

Calculates available UDP ports for each machine based on used ports in LocalChains.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get AvailableUDPPorts

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "AvailableUDPPorts",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "AvailableUDPPorts"
}

JSON

{
  "Value": {
    "PC1": {
      "UsedPorts": [],
      "AvailablePort": 4546
    },
    "PC2": {
      "UsedPorts": [],
      "AvailablePort": 4546
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=AvailableUDPPorts

Copy and paste into a browser to run - ⚠️ Executes immediately

CameraTrackingProtocols [GET]

CameraTrackingProtocols

Retrieves supported camera tracking protocols from connected CTS.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get CameraTrackingProtocols

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "CameraTrackingProtocols",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "CameraTrackingProtocols"
}

JSON

{
  "Value": {
    "Cameras": [
      {
        "Protocol": "Pixotope Tracking (TrackMen)",
        "PositiveX": "right",
        "PositiveY": "forward",
        "PositiveZ": "up"
      },
      {
        "Protocol": "Pixotope Pocket",
        "PositiveX": "right",
        "PositiveY": "up",
        "PositiveZ": "backward"
      }
    ]
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=CameraTrackingProtocols

Copy and paste into a browser to run - ⚠️ Executes immediately

PipelineTrackingStatuses [GET]

PipelineTrackingStatuses

Aggregates tracking statuses for all connected pipelines.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get PipelineTrackingStatuses

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "PipelineTrackingStatuses",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "PipelineTrackingStatuses"
}

JSON

{
  "Value": {
    "PC1": {}
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=PipelineTrackingStatuses

Copy and paste into a browser to run - ⚠️ Executes immediately

ZoneMachineCheckpoints [GET]

ZoneMachineCheckpoints

Service-owned Scene and TrackingData payloads are intentionally omitted.

No parameters — message is always {}.

Value

Result

OBJECT

Checkpoint names, calibration filenames, and alignment metadata.

Example - Get ZoneMachineCheckpoints

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ZoneMachineCheckpoints",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ZoneMachineCheckpoints"
}

{"Value":{"<MachineName>":{"<CheckpointName>":{...}}}}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ZoneMachineCheckpoints

Copy and paste into a browser to run - ⚠️ Executes immediately

ZoneStates [GET]

ZoneStates

Service-owned checkpoint Scene and TrackingData payloads are omitted.

No parameters — message is always {}.

Value

Result

OBJECT

Zone state per machine, including working Alignment.

Example - Get ZoneStates

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "ZoneStates",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "ZoneStates"
}

JSON

{
  "Value": {}
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=ZoneStates

Copy and paste into a browser to run - ⚠️ Executes immediately

VideoFilesInfo [GET]

VideoFilesInfo

Aggregates video file information (folder, loopback, running, stopped status) for all machine routings.

No parameters — message is always {}.

Value

Result

OBJECT

The result.

Example - Get VideoFilesInfo

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "VideoFilesInfo",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "VideoFilesInfo"
}

JSON

{
  "Value": {
    "PC1": {
      "cf356a1b-57ac-4615-8413-73e5674fc081": {
        "Folder": "",
        "LoopbackEnabled": false,
        "Running": false,
        "Stopped": true
      }
    },
    "PC2": {}
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=VideoFilesInfo

Copy and paste into a browser to run - ⚠️ Executes immediately

WebRTCNetworkConfig [GET]

WebRTCNetworkConfig

Aggregates WebRTC network configuration from store machines.

No parameters — message is always {}.

Value

WebRTCInterface	STRING	The web rtcinterface.
WebRTCPort	STRING	The web rtcport.

Example - Get WebRTCNetworkConfig

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "WebRTCNetworkConfig",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "WebRTCNetworkConfig"
}

JSON

{
  "Value": {
    "PC1": {
      "WebRTCInterface": "",
      "WebRTCPort": 16226
    },
    "PC2": {
      "WebRTCInterface": "",
      "WebRTCPort": 16226
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=WebRTCNetworkConfig

Copy and paste into a browser to run - ⚠️ Executes immediately

Endpoints [GET]

Endpoints

Aggregates available endpoints from all relays.

No parameters — message is always {}.

Value

State	BOOLEAN	The state.
PersistentState	BOOLEAN	The persistent state.
Calls	STRING	The calls.
Fields	STRING	The fields.

Example - Get Endpoints

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "QueryServer",
  "Name": "Endpoints",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "QueryServer",
  "Name": "Endpoints"
}

JSON

{
  "Value": {
    "State": false,
    "PersistentState": false,
    "Calls": {
      "CalculateXRARLatency": {
        "Params": [],
        "Description": "Spawns XRARSyncHandler actors on connected XR and AR machines to calculate latency",
        "Returns": {
          "Success": "boolean",
          "Description": "string"
        }
      },
      "DispatchMetaCall": {
        "Params": [
          "Endpoint",
          "IsAsync"
        ],
        "Description": "Dispatches a given method to a given service on the target machines",
        "Returns": {
          "Result": "object[]"
        }
      },
      "DuplicateCurrentShow": {
        "Params": [],
        "Description": "Duplicates the current show",
        "Returns": {
          "Result": "object"
        }
      },
      "GetAliveIP": {
        "Params": [],
        "Description": "Gets the IP address of the first connected CLIENT machine, or SERVER if no clients available",
        "Returns": {
          "Result": "string"
        }
      }
    },
    "Fields": {
      "AvailableTools": {
        "Description": "Aggregates available tools from all connected DRM servers",
        "Returns": {
          "Result": "object"
        }
      },
      "CaptureCameraImagesProgress": {
        "Description": "Tracks progress and blurriness metrics for camera image capture operation",
        "Returns": {
          "Progress": "number",
          "Blurriness": "number"
        }
      },
      "DaemonEvents": {
        "Description": "Aggregates EngineIsStarting events from all connected daemons",
        "Returns": {
          "Result": "object"
        }
      },
      "IOEffects": {
        "Description": "Aggregates IO effects (sharpen, visualizer, depth/normal generation, BPE) for all machine media",
        "Returns": {
          "Result": "object[]"
        }
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=QueryServer&Name=Endpoints

Copy and paste into a browser to run - ⚠️ Executes immediately

Relays

AvailableTools

CaptureCameraImagesProgress

DaemonEvents

IOEffects

LOWPRIO_CombinedSystemInfo

MachineGroups

MachineOutputtingKey

NetworkAdapters

Presets

ProjectsInfos

TimecodeReport

TotalDataSources

Color Matching

ColorMatchingInProgress

ColorMatchingProfiles

ColorMatchingProgress

ColorMatchingStatuses

Connected Clients

ConnectedBackupHandler

ConnectedClientMachines

ConnectedCTS

ConnectedDaemons

ConnectedDiagnostics

ConnectedDirectors

ConnectedEngines

ConnectedGateways

ConnectedLicenseDRMs

ConnectedMachines

ConnectedPipelines

ConnectedZones

Current Machine

CurrentDaemon

CurrentDirector

CurrentGateway

CurrentLicenseDRM

CurrentMachineTools

Dynamic Queries

DynamicCameras

DynamicGroups

DynamicIOBotEntities

DynamicIOBotPresets

DynamicLevels

DynamicMachines

DynamicNDISources

DynamicProjects

DynamicVideoInputs

DynamicVideoOutputs

DynamicVideowallLayouts

DynamicVideowallSlots

DynamicWebcamSources

Engine

CombinedEngineWorlds

EngineCameraPreviews

EngineOptions

EngineStates

EnginesVideowallTransitionReady

EngineXRFOVs

ReadyAndLaunchingEngines

ReadyEngines

Formats

InputSources

OutputSources

RunningPipeline

VideoOptions

VideoOptions

Inputs

CameraSystems

VideoInputs

VideoIOInputs

VideoIOOutputs

Machine Health

HealthThresholds

HealthyEngines

HealthyMachines

HealthySystemInfo

LOWPRIO_MachinesHealth

ParameterThresholds

ValidInvalidMachines

Machines