Pixotope Explorer API - Calls | Pixotope Help Center

Service name: <MachineName>-Explorer (one per machine).

Scripts

Endpoints for running user-provided scripts on the Explorer host machine. Scripts live in a `scripts` folder next to the Explorer executable (`[Current Pixotope version]\Services\Utilities\Explorer\scripts`); drop `.bat`, `.cmd`, `.ps1`, or `.exe` files there to make them available.

RunScript [CALL]

RunScript

Runs a script from the Explorer's scripts directory (the `scripts` folder next to the Explorer executable), either fire-and-forget or awaited for output.

Params

Name

STRING

Script name (with or without extension); no path separators or parent paths allowed.

Args

OPTIONAL

STRING

Arguments passed to the script. Defaults to an empty string.

Wait

OPTIONAL

(default: false)

BOOLEAN

When `true`, waits for completion and returns exit code and captured output.

Result

Started

BOOLEAN

Whether the script started successfully.

Example 1 - Run a script and wait for output

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Explorer",
  "RespondTo": "<Service>",
  "Method": "RunScript",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Name": "greet",
    "Args": "World",
    "Wait": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Explorer",
  "Method": "RunScript",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Started": true,
    "Script": "greet.bat",
    "Waited": true,
    "ExitCode": 0,
    "Stdout": "Hello World",
    "Stderr": ""
  }
}

Example 2 - Stop all Pixotope services except the Explorer

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Explorer",
  "RespondTo": "<Service>",
  "Method": "RunScript",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Name": "stop_px_services",
    "Wait": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Explorer",
  "Method": "RunScript",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Started": true,
    "Script": "stop_px_services.bat",
    "Waited": true,
    "ExitCode": 0,
    "Stdout": "Stopping PX_QueryServer.exe ...\nSkipping PX_Explorer.exe (Explorer host).\nDone. Stopped 1 Pixotope service image(s).",
    "Stderr": ""
  }
}

Try via Pixotope Gateway

Replace the example values with values for your system
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Call&Target=~LOCAL~-Explorer&Method=RunScript&ParamName=greet&ParamArgs=World&ParamWait=true

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