Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.pod.exec ​

Run a command on a Pod over a long-lived WebSocket session

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namespacestringYes——
namestringYes——
containerstringNo——
commandjsonYes——
ttybooleanNo——
stdinbooleanNo——
timeout_secondsintegerNo——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
namespacestringNo——
namestringNo——
containerstringNo——
commandjsonNo——
ttybooleanNo——
stdinbooleanNo——
timeout_secondsintegerNo——
organization_uuiduuidNo——
session_uuidstringNo——
ws_endpointstringNo——
streaming_podstringNo——
bytes_inintegerNo——
bytes_outintegerNo——
reasonstringNo——
failure_codestringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—open—
streamingNoNo———
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingopenstreaming—
streamingclosecompleted—
* (any state)failfailed—
streamingtimeoutfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "kubernetes.pod.exec",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value",
    "command": "value"
  }
}