Skip to content

Rippling: Create a new sandbox

Rippling restApi.createSandboxes: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.create_sandboxes

Provider route: POST /sandboxes/. 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"]["createSandboxes"]>[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.createSandboxes(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.create_sandboxes(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create a new sandbox — request body — body

Referenced models: Create a new sandbox — 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
$objectRoot
created_atstringRequired within parentRecord creation date
descriptionstringOptionalOptional sandbox description.
handlestringOptionalServer-generated sandbox handle.
idstringRequired within parentIdentifier field
namestringRequired within parentDisplay name of the sandbox.
statusstringOptionalCurrent lifecycle status.
typestringRequired within parentSandbox type. Supported value: “developer”.
Known values: developer
updated_atstringRequired within parentRecord update date
Create a new sandbox — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
config_overrideobjectOptionalOptional create-only sandbox configuration.
config_override.custom_objectsobjectOptionalCustom objects copied into the sandbox.
config_override.custom_objects.co_api_namesarrayOptionalCustom object API names copied into the sandbox.
config_override.custom_objects.co_api_names[]stringEach item
config_override.developerobjectOptionalRequired for developer sandboxes and omitted for full-data sandboxes.
config_override.developer.company_sizestringRequired within parentSeed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create.
One of: SMALL, MEDIUM
config_override.general_notificationsobjectOptionalGeneral outbound notification controls.
config_override.general_notifications.emailobjectRequired within parentEmail notification configuration.
config_override.general_notifications.email.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.email.allowed_users[]stringEach item
config_override.general_notifications.email.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.push_notificationsobjectRequired within parentPush notification configuration.
config_override.general_notifications.push_notifications.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.push_notifications.allowed_users[]stringEach item
config_override.general_notifications.push_notifications.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.slackobjectOptionalSlack notification configuration.
config_override.general_notifications.slack.allowed_public_channelsarrayOptionalPublic channels allowed to receive outbound messages.
config_override.general_notifications.slack.allowed_public_channels[]stringEach item
config_override.general_notifications.slack.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.slack.allowed_users[]stringEach item
config_override.general_notifications.slack.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.smsobjectRequired within parentSMS notification configuration.
config_override.general_notifications.sms.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.sms.allowed_users[]stringEach item
config_override.general_notifications.sms.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.general_notifications.teamsobjectOptionalMicrosoft Teams notification configuration.
config_override.general_notifications.teams.allowed_public_channelsarrayOptionalPublic channels allowed to receive outbound messages.
config_override.general_notifications.teams.allowed_public_channels[]stringEach item
config_override.general_notifications.teams.allowed_usersarrayOptionalUsers allowed to receive outbound messages.
config_override.general_notifications.teams.allowed_users[]stringEach item
config_override.general_notifications.teams.outbound_behaviorstringRequired within parentWhether outbound messages are allowed or suppressed.
One of: SUPPRESS, ALLOW
config_override.integrationsobjectOptionalRequired for connected full-data sandboxes.
config_override.integrations.is_risk_acknowledgedbooleanRequired within parentConfirms acceptance of the risks of connected third-party integrations.
config_override.sandbox_modestringOptionalRequired for full-data sandboxes. Developer sandboxes default to CONNECTED.
One of: CONNECTED, ISOLATED
config_override.workflow_webhooksobjectOptionalWorkflow webhook controls.
config_override.workflow_webhooks.allowed_ipsarrayOptionalIP addresses allowed to receive workflow webhooks.
config_override.workflow_webhooks.allowed_ips[]stringEach item
config_override.workflow_webhooks.allowlisted_webhook_urlsarrayOptionalWebhook URLs allowed in the sandbox.
config_override.workflow_webhooks.allowlisted_webhook_urls[]stringEach item
config_override.workflow_webhooks.outbound_behaviorstringOptionalWhether workflow webhook traffic is allowed or suppressed.
One of: SUPPRESS, ALLOW
descriptionstringOptionalOptional sandbox description.
namestringRequired within parentDisplay name of the sandbox.
typestringRequired within parentSandbox type. Supported value: "developer".
One of: developer

SDK function policy ID: rippling.rest_api.create_sandboxes. Catalog operation: create-sandboxes. 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: ["sandboxes.read-write"]

Provider entitlements: ["Developer_Base"]

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.