Skip to main content
POST
Replace text in sandbox files

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId
string
required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json
paths
string[]
required

Files up to 5 MiB each.

Required array length: 1 - 100 elements
pattern
string
required

Plain text. Every occurrence is replaced

newValue
string
required

Required. Use "" to delete the matches.

Response

Per-file results.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "file.replaced"
results
object[]
required

One result per file. A file that fails does not stop the others.

success
boolean