Rippling: Create a presigned staged upload batch
Rippling restApi.uploadBatchesPresignSites: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.upload_batches_presign_sites
Provider route: POST /sites/upload-batches/presign/. 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"]["uploadBatchesPresignSites"]>[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.uploadBatchesPresignSites(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.upload_batches_presign_sites(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Create a presigned staged upload batch — request body — body |
Referenced models: Create a presigned staged upload batch — 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 |
|---|---|---|---|
$ | Model | Root | Expand Create a presigned staged upload batch — response body |
Referenced models: Create a presigned staged upload batch — response body
Schemas
Section titled “Schemas”Create a presigned staged upload batch — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | array | Optional | Staged files created by the upload batch. |
files[] | Model | Each item | Expand Create a presigned staged upload batch — response body — files item |
upload_batch_id | string | Optional | Identifier for the staged upload batch. |
Referenced models: Create a presigned staged upload batch — response body — files item
Create a presigned staged upload batch — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_intents | array | Required within parent | Non-empty array of file upload intents to stage with presigned S3 upload URLs. |
file_intents[] | Model | Each item | Expand Create a presigned staged upload batch — request body — body file intents item |
Referenced models: Create a presigned staged upload batch — request body — body file intents item
Create a presigned staged upload batch — response body — files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_ref | string | Optional | Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response. |
file_id | string | Optional | Staged upload identifier for use in create, update, or file operations after uploading bytes to S3. 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. |
file_name | string | Optional | Staged file name from the presign file_name intent. |
status | string | Optional | Upload status. Returns awaiting_upload after presign until the file is uploaded to S3. After the object exists in S3, status becomes active on first use. Attach does not consume the staged upload; it is removed after expiry. |
upload_fields | object | Optional | Form fields required for the S3 POST (send these before the file part). |
upload_url | string | Optional | Presigned S3 POST URL for uploading the file bytes. |
Create a presigned staged upload batch — request body — body file intents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_ref | string | Required within parent | Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response. |
file_name | string | Required within parent | File name with extension (e.g. site.zip). Used to derive Content-Type and create/PATCH asset type. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.upload_batches_presign_sites. Catalog operation: upload-batches-presign-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"}