Skip to content
Runta Runta

Run a buffered command

POST
/v1/runtimes/{runtime_id}/exec
 
curl --request POST \
  --url http://127.0.0.1:8080/v1/runtimes/example/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "args": [], "command": "example", "cwd": "example", "env": { "additionalProperty": "example" }, "max_output_bytes": 1, "stdin": "example", "timeout_secs": 1 }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
runtime_id
required

Runtime UUID or display name.

string

Runtime UUID or display name.

Request Body required

Section titled “Request Body required ”

Buffered command execution request.

Media type application/json

Buffered command execution request.

object
args

Positional arguments.

Array<string>
default:
command
required

Executable or shell command.

string
cwd

Working directory inside the runtime.

string
nullable
env

Environment variables.

object
key
additional properties
string
max_output_bytes

Maximum bytes to retain per output stream.

integer format: uint
nullable <= 4194304
stdin

Standard input as UTF-8 text.

string
nullable
timeout_secs

Timeout in seconds.

integer format: uint64
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response envelope.

Media type application/json

Response envelope.

object
data
required

Buffered command execution response.

object
duration_ms
required

Wall-clock execution duration in milliseconds.

integer format: uint64
exit_code
required

Process exit code.

integer format: int32
stderr
required

Captured standard error as UTF-8 lossily decoded text.

string
stderr_truncated
required

Whether stderr exceeded the requested cap.

boolean
stdout
required

Captured standard output as UTF-8 lossily decoded text.

string
stdout_truncated
required

Whether stdout exceeded the requested cap.

boolean
Example generated
{
  "data": {
    "duration_ms": 1,
    "exit_code": 1,
    "stderr": "example",
    "stderr_truncated": true,
    "stdout": "example",
    "stdout_truncated": true
  }
}

401

Section titled “401 ”

Missing, malformed, or rejected bearer token

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

403

Section titled “403 ”

The bearer token is not allowed to perform this action

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

404

Section titled “404 ”

The requested resource was not found

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

409

Section titled “409 ”

The request conflicts with current resource state

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

422

Section titled “422 ”

Validation or application error

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

503

Section titled “503 ”

Upstream service is unavailable

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

504

Section titled “504 ”

Upstream request timed out

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}

default

Section titled “default ”

Error response

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example 
{
  "error": {
    "code": "already_exists"
  }
}