Rippling: Start a managed package install
Rippling restApi.installPackageManagedInstalls: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.install_package_managed_installs
Provider route: POST /package-managed-installs/. 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"]["installPackageManagedInstalls"]>[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.installPackageManagedInstalls(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.install_package_managed_installs(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.allow_post_install_function | boolean | Optional | Accepted for backward compatibility and ignored. Configured post-install functions always run after installation. Default: false |
body.install_key | string | Required within parent | The install key for this managed package install. |
body.package_key | string | Required within parent | The package key of the managed package to install. |
body.service_account_role_id | string | Optional | Optional service-account role id. Omit it to install as the authenticated caller. When set, the role must be a service account in the caller’s company that the caller is allowed to assume. A missing role, a role in another company, a role that is not a service account, or a service account the caller cannot assume returns HTTP 400. Use a service-account role id this caller is allowed to assume. There is no public list endpoint for these ids. |
body.version_id | string | Required within parent | The published package version to install. |
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 | Living managed package install in a subscriber company. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
install_key | string | Optional | The install key of the managed package install |
installed_version_id | string | Optional | The published package version currently installed or being installed |
package_key | string | Optional | The package key of the managed package |
post_install_function_api_name | JSON | Optional | |
post_install_function_api_name (anyOf 1) | string | Alternative | The installed Function’s API name for retrieving its execution. Null if no hook was attempted or for older installations. Managed names include the package and install namespace. |
post_install_function_api_name (anyOf 2) | null | Alternative | |
post_install_function_error_code | JSON | Optional | |
post_install_function_error_code (anyOf 1) | string | Alternative | The last installation hook failure. Wire values start with POST_INSTALL_FUNCTION_: MAPPING_MISSING means the installed Function mapping is absent; DEPLOYMENT_NOT_FOUND means no deployment exists; DEPLOYMENT_FAILED means deployment failed; DEPLOYMENT_TIMEOUT means deployment readiness timed out; PERMISSION_DENIED means installer authorization failed; EXECUTION_FAILED means execution failed; EXECUTION_TIMEOUT means the hook activity timed out. Null on success, when no hook was attempted, or for older installations. Managed upgrades do not rerun the hook and preserve this outcome. Known values: POST_INSTALL_FUNCTION_MAPPING_MISSING, POST_INSTALL_FUNCTION_DEPLOYMENT_NOT_FOUND, POST_INSTALL_FUNCTION_DEPLOYMENT_FAILED, POST_INSTALL_FUNCTION_DEPLOYMENT_TIMEOUT, POST_INSTALL_FUNCTION_PERMISSION_DENIED, POST_INSTALL_FUNCTION_EXECUTION_FAILED, POST_INSTALL_FUNCTION_EXECUTION_TIMEOUT |
post_install_function_error_code (anyOf 2) | null | Alternative | |
post_install_function_run_id | JSON | Optional | |
post_install_function_run_id (anyOf 1) | string | Alternative | The Function execution ID, recorded on success and failure when a run was created. Use with post_install_function_api_name at GET /functions/{function_api_name}/executions/{execution_id}/. Function execution permissions still apply. Null if no run was created or for older installations. |
post_install_function_run_id (anyOf 2) | null | Alternative | |
post_install_landing_component | object | Optional | Component to open after installation completes |
progress | array | Optional | Installation progress entries |
progress[] | JSON | Each item | Additional keys: see wildcard field |
progress[].* | JSON | Additional keys | |
status | string | Optional | Managed install status (INSTALLING, UPDATING, UNINSTALLING, ACTIVE, ACTIVE_WITH_WARNINGS, UNINSTALLED, FAILED, or UNINSTALL_FAILED). ACTIVE_WITH_WARNINGS means components were installed but post-processing or the post-install function failed. Read warning_message for details. Installed components and data written by the function are retained. Known values: ACTIVE, ACTIVE_WITH_WARNINGS, INSTALLING, UPDATING, UNINSTALLING, UNINSTALL_FAILED, UNINSTALLED, FAILED |
updated_at | string | Required within parent | Record update date |
warning_message | JSON | Optional | |
warning_message (anyOf 1) | string | Alternative | Non-fatal warning details when status is ACTIVE_WITH_WARNINGS. Null when there are no warnings or details were not recorded for an older installation. |
warning_message (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.install_package_managed_installs. Catalog operation: install-package-managed-installs. 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-install.read-write"]
Provider entitlements: ["Unity_Packages_V2_Platform_API"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}