Skip to main content
POST
/
v1
/
volumes
/
{id}
/
files
/
replace
Replace text in volume files
import requests

url = "https://api.13-215-85-171.sslip.io/v1/volumes/{id}/files/replace"

payload = {
    "files": ["<string>"],
    "pattern": "<string>",
    "replacement": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "dry_run": true,
  "replacements": 123,
  "files_modified": 123,
  "files_skipped": 123,
  "binary_files_skipped": 123
}

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Volume ID

Body

application/json
files
string[]
required

Absolute volume-internal file paths rooted at /.

pattern
string
required

Regex to replace within the target files.

replacement
string
required
dry_run
boolean
default:false

When true, returns replacement counters without mutating any file contents.

Response

Replacement result

dry_run
boolean
required
replacements
integer<uint64>
required
files_modified
integer<uint64>
required
files_skipped
integer<uint64>
required
binary_files_skipped
integer<uint64>
required