Skip to main content
PUT
Write a file

Authorizations

Authorization
string
header
required

A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.

Path Parameters

sandboxId
string
required

A sandbox id, sbx_….

Query Parameters

path
string
required

Relative to the sandbox root (/Users/<slot>/offstage-sandbox/<sandbox id>): letters, digits, ., _, - and /, no .. segment, no leading / or ~, at most 1024 characters. . segments and repeated slashes are normalized away.

Required string length: 1 - 1024
Pattern: ^(?!/)(?!(.*/)?\.\.(/|$))[A-Za-z0-9._/-]+$

Body

application/octet-stream

The file's bytes, sent as-is. Any content-type is accepted; an empty body writes an empty file.

The body is of type file.

Response

The file was written.

path
string
required

The path as the plane normalized it (./a//b becomes a/b).

bytes
integer
required

How many bytes were written.

Required range: x >= 0