Skip to content

Edit a file (find and replace)

POST
/v1/sandbox/{sandboxID}/filesystem/edit-file

Apply one or more find-and-replace edits within a single file.

sandboxID
required
string

Unique sandbox identifier.

object
path
required

Path to the file.

string
edits
required

List of find-and-replace edits to apply.

Array<object>
>= 1 items
object
find
required

Text to find.

string
replace

Replacement text.

string
nullable

Edit result with diff and replacement count.

object
diff
required

Unified diff of the changes made.

string
replacements
required

Total number of replacements made.

integer

Bad request – validation error.

object
message
required

Summary message, e.g. “Invalid request”.

string
errors
required
Array<object>
object
field
required

JSON field name that failed validation (e.g. “path”, “command”).

string
error
required

Human-readable description of the validation failure.

string

Unauthorized – invalid or missing API key.

object
message
required

Human-readable error message.

string

Resource not found.

object
message
required

Human-readable error message.

string