Configure the supervised service

PUT/sandboxes/{id}/service

Experimental. Sets and (re)starts the guest's supervised long-lived entrypoint.

path parameters

object

idstringrequired

Sandbox ID, e.g. sbx_ab12cd34.

Request bodyapplication/json

ConfigureServiceReq

cmdarray | null

items

string

cwdstring

envobject

additional properties

string

env_exactboolean

log_buffer_bytesinteger

restartWireRestartPolicy

max_retriesinteger

policystring

stop_grace_sinteger

stop_signalstring

userstring

Responses

200 OKOK

WireServiceStatus

last_exitWireExecResult

duration_msintegerint64

errorstring

exit_codeinteger

oom_killedboolean

signalstring

timed_outboolean

usageWireResourceUsage

context_switches_involuntaryintegerint64

cpu_sys_msintegerint64

cpu_user_msintegerint64

io_read_bytesintegerint64

io_write_bytesintegerint64

page_faults_majorintegerint64

peak_memory_bytesintegerint64

last_exit_at_unix_msintegerint64

last_exit_requestedboolean

live_peak_rss_bytesintegerint64

live_rss_bytesintegerint64

log_dropped_bytesintegermin 0

log_first_seqintegermin 0

log_next_seqintegermin 0

pidinteger

restartsinteger

specWireServiceSpec

cmdarray | null

items

string

cwdstring

envobject

additional properties

string

env_exactboolean

log_buffer_bytesinteger

restartWireRestartPolicy

max_retriesinteger

policystring

stop_grace_sinteger

stop_signalstring

userstring

started_at_unix_msintegerint64

statestring

uptime_msintegerint64

400 Bad requestBad Request

ErrorResponse

errorstring

404 Not foundNot Found

ErrorResponse

errorstring

Authentication

bearerAuthHTTP bearer. Daemon API key. Omit on a keyless loopback daemon.

Request

▍PUT/sandboxes/{id}/service

cURL

curl '/sandboxes/{id}/service' \
  -X PUT \
  -H 'Content-Type: application/json' \
  -d '{}'

JavaScript

const response = await fetch("/sandboxes/{id}/service", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
  },
  body: "{}",
});
const data = await response.json();

Python

import requests

response = requests.put(
    "/sandboxes/{id}/service",
    headers={
    "Content-Type": "application/json",
},
    data="{}",
)
data = response.json()

Response

200 OK

{
  "last_exit": {
    "duration_ms": 0,
    "error": "string",
    "exit_code": 0,
    "oom_killed": false,
    "signal": "string",
    "timed_out": false,
    "usage": {
      "context_switches_involuntary": 0,
      "cpu_sys_ms": 0,
      "cpu_user_ms": 0,
      "io_read_bytes": 0,
      "io_write_bytes": 0,
      "page_faults_major": 0,
      "peak_memory_bytes": 0
    }
  },
  "last_exit_at_unix_ms": 0,
  "last_exit_requested": false,
  "live_peak_rss_bytes": 0,
  "live_rss_bytes": 0,
  "log_dropped_bytes": 0,
  "log_first_seq": 0,
  "log_next_seq": 0,
  "pid": 0,
  "restarts": 0,
  "spec": {
    "cmd": [
      "string"
    ],
    "cwd": "string",
    "env": {},
    "env_exact": false,
    "log_buffer_bytes": 0,
    "restart": {
      "max_retries": 0,
      "policy": "string"
    },
    "stop_grace_s": 0,
    "stop_signal": "string",
    "user": "string"
  },
  "started_at_unix_ms": 0,
  "state": "string",
  "uptime_ms": 0
}