Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.api_namestringRequired within parent
bodyModelRequired within parentExpand Apply file operations to a site bundle — request body — body

Referenced models: Apply file operations to a site bundle — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRootResponse/resource shape for a custom site.
admin_group_idstringOptionalThe admin group id for the custom site
api_namestringOptionalThe unique api name of the custom site
created_atstringOptionalRecord creation date
created_bystringOptionalThe ID of the role that created the custom site
current_bundle_idstringOptionalThe active bundle id for the custom site
descriptionstringOptionalThe optional description of the custom site
idstringOptionalIdentifier field
logostringOptionalA Rippling-owned logo URL for the custom site
namestringOptionalThe display name of the custom site
viewer_group_idstringOptionalThe viewer group id for the custom site
Apply file operations to a site bundle — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
base_bundle_idstringRequired within parentMust match the site's current active bundle. Returns 409 when stale.
entry_pathstringOptionalOptional bundle entry path. When omitted, the current entry path is kept.
operationsarrayRequired within parentNon-empty array of file or directory operations.
operations[]ModelEach itemExpand 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
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.

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"}

Official provider source

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.