Skip to main content
v1

Write input to a process.

POST /v1/processes/{id}/input: request parameters and responses.

POST /v1/processes/{id}/input

Sends data to a process’s stdin (pipe mode) or PTY writer (tty mode). Data can be encoded as base64, utf8, or text. Returns 413 if the decoded payload exceeds the configured maxInputBytesPerRequest limit.

Parameters

NameInRequiredTypeDescription
idpathYesstringProcess ID

Parameter schemas

[
  {
    "name": "id",
    "in": "path",
    "description": "Process ID",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request body

Required.

application/json

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

Related schemas: ProcessInputRequest.

Responses

200

Input accepted

Content type: application/json

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

Related schemas: ProcessInputResponse.

400

Invalid request

Content type: application/json

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

Related schemas: ProblemDetails.

409

Process not writable

Content type: application/json

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

Related schemas: ProblemDetails.

413

Input exceeds configured limit

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.