Skip to content

Rippling: Apply file operations to a site bundle — request body — body operations item

Apply file operations to a site bundle: request body, field body / operations / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Apply file operations to a site bundle — request body — body operations item

FieldTypePresenceDescription and constraints
$objectRoot
file_idstringOptionalStaged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required for put operations on files. The id can be reused for 1 hour from presign, each attach copies the bytes into that site’s bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.
from_pathstringOptionalSource path for rename and move operations.
kindstringRequired within parentTarget kind. Supported values are file and directory.
opstringRequired within parentOperation type. Supported values are put, rename, move, and delete. move is valid for files only; directories support put, rename, and delete.
pathstringOptionalTarget path for put and delete operations.
recursivebooleanOptionalWhen true, delete directory removes nested files. Used by delete directory operations.
to_pathstringOptionalDestination path for rename and move operations.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.