Rippling: Retrieve a package sandbox link
Rippling restApi.getPackageSandboxLinks: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.get_package_sandbox_links
Provider route: GET /package-sandbox-links/{tracker_id}/. 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"]["getPackageSandboxLinks"]>[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.getPackageSandboxLinks(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.get_package_sandbox_links(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.tracker_id | string | Required within parent |
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 Retrieve a package sandbox link — response body |
Referenced models: Retrieve a package sandbox link — response body
Schemas
Section titled “Schemas”Retrieve a package sandbox link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request to link a package to a sandbox, or poll an EDIT-mode installation tracker. |
created_at | string | Required within parent | Record creation date |
error_message | string | Optional | Error message when EDIT-mode linking failed |
id | string | Required within parent | Identifier field |
installation_record_id | string | Optional | Installation record ID when EDIT-mode linking completes |
installation_tracker_id | string | Optional | The internal sandbox installation tracker ID |
mode | string | Required within parent | How the sandbox is linked to the package (INSTALL or EDIT) |
package_key | string | Required within parent | The package key to link into the sandbox |
package_version_id | string | Optional | The package version being linked in EDIT mode |
post_install_landing_component | object | Optional | Component to open after EDIT-mode linking completes |
progress | array | Optional | EDIT-mode installation progress entries |
progress[] | JSON | Each item | Additional keys: see wildcard field |
progress[].* | JSON | Additional keys | |
sandbox_company_id | string | Required within parent | The company receiving the sandbox package installation |
status | string | Optional | INSTALL completion status, or EDIT installation tracker status |
updated_at | string | Required within parent | Record update date |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.get_package_sandbox_links. Catalog operation: get-package-sandbox-links. 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: ["packages.read-write"]
Provider entitlements: ["Unity_Packages_V2_Platform_API"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}