ReferenceSandbox
ResourcesSandbox

Sandbox

Exec

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for POST /exec.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/exec" \  -H "Content-Type: application/json" \  -d '{}'
{  "exec_id": "string",  "exit_code": 0,  "signal": "string",  "stdout": "string",  "stderr": "string",  "duration_ms": 0,  "timed_out": true,  "stdout_truncated": true,  "stderr_truncated": true}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List Bg Execs

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec/bg

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Query Parameters

tag?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/exec/bg"
{  "execs": [    {      "exec_id": "string",      "pid": 0,      "state": "string",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "duration_ms": 0,      "exit_code": 0,      "signal": "string",      "stdout_bytes": 0,      "stderr_bytes": 0,      "tag": "string"    }  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Exec Bg

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec/bg

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for POST /exec/bg.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/exec/bg" \  -H "Content-Type: application/json" \  -d '{}'
{  "exec_id": "string",  "pid": 0,  "started_at": "2019-08-24T14:15:22Z",  "tag": "string"}
{  "exec_id": "string",  "pid": 0,  "started_at": "2019-08-24T14:15:22Z",  "tag": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Bg Exec

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec/bg/{id}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/exec/bg/string"
{  "exec_id": "string",  "pid": 0,  "state": "string",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "duration_ms": 0,  "exit_code": 0,  "signal": "string",  "stdout_bytes": 0,  "stderr_bytes": 0,  "tag": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete Bg Exec

DELETE
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec/bg/{id}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/sandbox/v1/string/string/string/runs/string/exec/bg/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Bg Exec Logs

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec/bg/{id}/logs

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Query Parameters

stream?string
offset?integer
max_bytes?integer

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/exec/bg/string/logs"
{  "exec_id": "string",  "stream": "string",  "offset": 0,  "next_offset": 0,  "bytes": 0,  "data": "string",  "eof": true,  "state": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Signal Bg Exec

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/exec/bg/{id}/signal

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for signal endpoints.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/exec/bg/string/signal" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Fs Ls

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/fs/ls

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Query Parameters

path?string
recursive?boolean
max_entries?integer

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/fs/ls"
{  "path": "string",  "entries": [    {      "name": "string",      "type": "string",      "size": 0,      "mtime": "2019-08-24T14:15:22Z",      "mode": "string",      "symlink_target": "string"    }  ],  "truncated": true}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Fs Mkdir

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/fs/mkdir

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for POST /fs/mkdir.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/fs/mkdir" \  -H "Content-Type: application/json" \  -d '{}'
{  "path": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Fs Rm

DELETE
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/fs/rm

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Query Parameters

path?string
recursive?boolean

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/sandbox/v1/string/string/string/runs/string/fs/rm"
{  "path": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Fs Stat

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/fs/stat

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Query Parameters

path?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/fs/stat"
{  "path": "string",  "type": "string",  "size": 0,  "mtime": "2019-08-24T14:15:22Z",  "mode": "string",  "uid": 0,  "gid": 0,  "symlink_target": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Ping

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/ping

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/ping"
{  "status": "string",  "version": "string",  "uptime_ms": 0,  "last_activity": "2019-08-24T14:15:22Z",  "execs_running": 0,  "ptys_running": 0,  "ptys_attached": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List Ptys

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/pty

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Query Parameters

tag?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/pty"
{  "sessions": [    {      "pty_id": "string",      "pid": 0,      "state": "string",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "duration_ms": 0,      "exit_code": 0,      "signal": "string",      "last_activity": "2019-08-24T14:15:22Z",      "last_client_activity": "2019-08-24T14:15:22Z",      "detached_since": "2019-08-24T14:15:22Z",      "attached": true,      "cols": 0,      "rows": 0,      "tag": "string"    }  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create Pty

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/pty

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for POST /pty.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/pty" \  -H "Content-Type: application/json" \  -d '{}'
{  "pty_id": "string",  "pid": 0,  "state": "string",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "duration_ms": 0,  "exit_code": 0,  "signal": "string",  "last_activity": "2019-08-24T14:15:22Z",  "last_client_activity": "2019-08-24T14:15:22Z",  "detached_since": "2019-08-24T14:15:22Z",  "attached": true,  "cols": 0,  "rows": 0,  "tag": "string"}
{  "pty_id": "string",  "pid": 0,  "state": "string",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "duration_ms": 0,  "exit_code": 0,  "signal": "string",  "last_activity": "2019-08-24T14:15:22Z",  "last_client_activity": "2019-08-24T14:15:22Z",  "detached_since": "2019-08-24T14:15:22Z",  "attached": true,  "cols": 0,  "rows": 0,  "tag": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Pty

GET
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/pty/{id}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox/v1/string/string/string/runs/string/pty/string"
{  "pty_id": "string",  "pid": 0,  "state": "string",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "duration_ms": 0,  "exit_code": 0,  "signal": "string",  "last_activity": "2019-08-24T14:15:22Z",  "last_client_activity": "2019-08-24T14:15:22Z",  "detached_since": "2019-08-24T14:15:22Z",  "attached": true,  "cols": 0,  "rows": 0,  "tag": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete Pty

DELETE
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/pty/{id}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/sandbox/v1/string/string/string/runs/string/pty/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Resize Pty

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/pty/{id}/resize

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for POST /pty/{id}/resize.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/pty/string/resize" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Signal Pty

POST
/sandbox/v1/{namespace}/{owner}/{project}/runs/{uuid}/pty/{id}/signal

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string
owner*string
project*string
uuid*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for signal endpoints.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sandbox/v1/string/string/string/runs/string/pty/string/signal" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Project Searches
Schemas

On this page

ExecList Bg ExecsExec BgGet Bg ExecDelete Bg ExecGet Bg Exec LogsSignal Bg ExecFs LsFs MkdirFs RmFs StatPingList PtysCreate PtyGet PtyDelete PtyResize PtySignal Pty

Actions

Give us feedback