Skip to main content
v1

Run a one-shot command.

POST /v1/processes/run: request parameters and responses.

POST /v1/processes/run

Executes a command to completion and returns its stdout, stderr, exit code, and duration. Supports configurable timeout and output size limits.

Request body

Required.

application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProcessRunRequest"
  }
}

Related schemas: ProcessRunRequest.

Responses

200

One-off command result

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProcessRunResponse"
  }
}

Related schemas: ProcessRunResponse.

400

Invalid request

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.

501

Process API unsupported on this platform

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.