Diagnostics API - Calls | Pixotope Help Center

Shutdown [CALL]

Shutdown

Stops the Diagnostics service after responding to the caller.

No params.

Result

Result

BOOLEAN

Always `true` when the shutdown request was accepted.

Example - Shut down Diagnostics

Request (you send)

JSON

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

JSON

{}

Response (you receive)

JSON

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

JSON

{
  "Result": true
}

CreateDump [CALL]

CreateDump

Collects a PixotopeDump zip for this machine. When `IncludeAllMachines` is true, Diagnostics calls `GetLocalDump` on reachable peer Diagnostics services and combines all results into one zip.

Params

IncludeAllMachines	BOOLEAN	If true, gather and combine dumps from all reachable Diagnostics services.
RemoteTimeoutSecs	NUMBER	Optional per-peer timeout in seconds for remote `GetLocalDump` calls.

Result

Result

OBJECT

`DumpResult` with `Passed`, `ZipPath`, optional `Error`, and `Info` metadata.

Example 1 - Create a local dump

Request (you send)

JSON

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

JSON

{
  "Params": {
    "IncludeAllMachines": false
  }
}

Response (you receive)

JSON

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

JSON

{
  "Result": {
    "Passed": true,
    "ZipPath": "C:\\Pixotope\\SILENT\\Logs\\PixotopeDump 03-06-26_12-00-00.zip",
    "Info": {
      "Name": "PixotopeDump 03-06-26_12-00-00",
      "Fullname": "PixotopeDump 03-06-26_12-00-00.zip"
    }
  }
}

Example 2 - Create a combined dump

Request (you send)

JSON

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

JSON

{
  "Params": {
    "IncludeAllMachines": true,
    "RemoteTimeoutSecs": 60
  }
}

Response (you receive)

JSON

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

JSON

{
  "Result": {
    "Passed": true,
    "ZipPath": "C:\\Pixotope\\SILENT\\Logs\\PixotopeDumpCombined 03-06-26_12-00-00.zip"
  }
}

GetLocalDump [CALL]

GetLocalDump

Collects a PixotopeDump zip for this machine only. This is used directly by local callers and internally by `CreateDump` when collecting remote peer data.

Params

ReturnBytes	BOOLEAN	If true, include the produced zip as base64 in `Result.ZipBytes`.
Compress	BOOLEAN	If false, write an uncompressed transport zip for later recompression by the coordinator.
OutputNextToExe	BOOLEAN	If true, write the compressed zip next to the running executable instead of the standard Logs folder.
RemoveExistingDumps	BOOLEAN	If true, remove existing `PixotopeDump*.zip` files from the output directory before writing the new dump.

Result

Result

OBJECT

`DumpResult` with `Passed`, `ZipPath`, optional `ZipBytes`, optional `Error`, and `Info` metadata.

Example - Collect a local dump and return bytes

Request (you send)

JSON

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

JSON

{
  "Params": {
    "ReturnBytes": true,
    "Compress": false
  }
}

Response (you receive)

JSON

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

JSON

{
  "Result": {
    "Passed": true,
    "ZipPath": "C:\\Pixotope\\SILENT\\Services\\Diagnostics\\PixotopeDump 03-06-26_12-00-00.zip",
    "ZipBytes": "<base64>"
  }
}