ITitential
Gateway Manager

Execute code on a Gateway

Changed on

Executes code (e.g. Python) on a Gateway5 cluster without requiring a pre-configured service. The code is sent directly to the gateway for execution.

post/gateway_manager/v1/code/run

Request

  • Base URL
    https://example.itential.io
  • URL
    https://example.itential.io/gateway_manager/v1/code/run
  • Auth
    none declared

Request body

clusterIdstring
language'python'
codestring
dataGatewayManagerV1CodeRunPostRequestBodyContentApplicationJsonSchemaData
packagesstring[]

Response

The execution result from the gateway including stdout, stderr, return code, and timing

idstring
jsonrpcstring
status'completed' | 'error'
receiveTimeinteger
return_codeinteger

Process exit code (0 = success, >=1 = error)

stdoutstring

Raw standard output from the script execution

stderrstring

Standard error from the script execution

started_atstring

ISO 8601 timestamp when execution started on the runner

finished_atstring

ISO 8601 timestamp when execution completed on the runner

elapsed_msnumber double

Server-measured execution time in milliseconds

Changes