Skip to main content
POST
Create the managed sandbox of a claim a self-hosted runner holds

Authorizations

X-Outerlayer-App-Id
string
header
required

Factory id the request is scoped to.

Authorization
string
header
required

API key (sk_outerlayer_*)

Headers

Signature
string

HTTP Message Signature (RFC 9421) made with the runner key's host key: runner=:<base64>:.

Signature-Input
string

The signature's covered components and parameters: runner=("@method" "@path" "@query" "content-digest");created=<unix seconds>;nonce="<random>";keyid="<host key fingerprint>";alg="ed25519".

Content-Digest
string

RFC 9530 digest of the request body, always sent, including for a request with none: sha-256=:<base64>:.

Path Parameters

workItemId
string
required

Body

application/json
idleMinutes
number

Minutes with no activity after which the provider ends the sandbox. Kept inside 1 to 120.

machine
enum<string>

The machine size. Absent, small. A claim that had a sandbox before keeps the size of its first one.

Available options:
small,
large
metadata
object

The runner's own labels for the sandbox, which a list returns.

timeLimitMinutes
number

Minutes of running time after which the provider ends the sandbox. At most 1440.

Response

The sandbox of the claim.

data
object
required