Rippling: Apply file operations to a site bundle
Rippling restApi.fileOperationsSites: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.file_operations_sites
Provider route: POST /sites/{api_name}/file-operations/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["fileOperationsSites"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.fileOperationsSites(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.file_operations_sites(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.api_name | string | Required within parent | |
body | Model | Required within parent | Expand Apply file operations to a site bundle — request body — body |
Referenced models: Apply file operations to a site bundle — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response/resource shape for a custom site. |
admin_group_id | string | Optional | The admin group id for the custom site |
api_name | string | Optional | The unique api name of the custom site |
created_at | string | Optional | Record creation date |
created_by | string | Optional | The ID of the role that created the custom site |
current_bundle_id | string | Optional | The active bundle id for the custom site |
description | string | Optional | The optional description of the custom site |
id | string | Optional | Identifier field |
logo | string | Optional | A Rippling-owned logo URL for the custom site |
name | string | Optional | The display name of the custom site |
viewer_group_id | string | Optional | The viewer group id for the custom site |
Schemas
Section titled “Schemas”Apply file operations to a site bundle — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_bundle_id | string | Required within parent | Must match the site's current active bundle. Returns 409 when stale. |
entry_path | string | Optional | Optional bundle entry path. When omitted, the current entry path is kept. |
operations | array | Required within parent | Non-empty array of file or directory operations. |
operations[] | Model | Each item | Expand Apply file operations to a site bundle — request body — body operations item |
Referenced models: Apply file operations to a site bundle — request body — body operations item
Apply file operations to a site bundle — request body — body operations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Optional | Staged 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_path | string | Optional | Source path for rename and move operations. |
kind | string | Required within parent | Target kind. Supported values are file and directory. |
op | string | Required within parent | Operation type. Supported values are put, rename, move, and delete. move is valid for files only; directories support put, rename, and delete. |
path | string | Optional | Target path for put and delete operations. |
recursive | boolean | Optional | When true, delete directory removes nested files. Used by delete directory operations. |
to_path | string | Optional | Destination path for rename and move operations. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.file_operations_sites. Catalog operation: file-operations-sites. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["sites.read-write"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}