Console endpoint

Execute Console Command

POST/console-commands/

Example request

application/json

{
  "resourceId": "my-interactive-resource",
  "command": "hostname"
}

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/console-commands/"

Supply a valid request.json before running this command.

201 Createdapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

{
  "id": "string",
  "resourceId": "string",
  "runtimeId": "string",
  "connectionId": "string",
  "actorId": "string",
  "command": "string",
  "workingDirectory": "string",
  "environment": {},
  "cpuCores": 0,
  "memoryBytes": 0,
  "timeoutSeconds": 0,
  "status": "string",
  "stdout": "string",
  "stderr": "string",
  "exitCode": 0,
  "externalId": "string",
  "failure": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "startedAt": "2026-01-01T00:00:00Z",
  "finishedAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

Replace the example resourceId with a saved resource that supports one-shot commands. resourceId and command are required; timeoutSeconds defaults to 30 and cannot exceed 3600. The request waits for the runner and returns a command record. A runner failure can return 201 Created with status: failed; inspect status, exitCode, and failure instead of treating HTTP status as command success.

Related guide

See the Console guide for related tasks and context.