Skip to content

Rippling: Retrieve a managed package install

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

← Rest API operations · Get started

Operation rippling.rest_api.get_package_managed_installs

Provider route: GET /package-managed-installs/{install_id}/. 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"]["getPackageManagedInstalls"]>[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.getPackageManagedInstalls(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.get_package_managed_installs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.install_idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$objectRootLiving managed package install in a subscriber company.
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
install_keystringOptionalThe install key of the managed package install
installed_version_idstringOptionalThe published package version currently installed or being installed
package_keystringOptionalThe package key of the managed package
post_install_function_api_nameJSONOptional
post_install_function_api_name (anyOf 1)stringAlternativeThe 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)nullAlternative
post_install_function_error_codeJSONOptional
post_install_function_error_code (anyOf 1)stringAlternativeThe 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)nullAlternative
post_install_function_run_idJSONOptional
post_install_function_run_id (anyOf 1)stringAlternativeThe 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)nullAlternative
post_install_landing_componentobjectOptionalComponent to open after installation completes
progressarrayOptionalInstallation progress entries
progress[]JSONEach itemAdditional keys: see wildcard field
progress[].*JSONAdditional keys
statusstringOptionalManaged 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_atstringRequired within parentRecord update date
warning_messageJSONOptional
warning_message (anyOf 1)stringAlternativeNon-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)nullAlternative

SDK function policy ID: rippling.rest_api.get_package_managed_installs. Catalog operation: get-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"}

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.