Skip to content

Rippling: List software deployments

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

← Rest API operations · Get started

Operation rippling.rest_api.list_software_deployments

Provider route: GET /software-deployments/. 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"]["listSoftwareDeployments"]>[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.listSoftwareDeployments(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.list_software_deployments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List software deployments — response body — results item

Referenced models: List Sites — response body — meta, List software deployments — response body — results item

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
List software deployments — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
active_group_typestringOptionalType of group targeting: 'Role' or 'Device'.
Known values: Role, Device
created_atstringRequired within parentRecord creation date
group_idstringOptionalGroup ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.
idstringRequired within parentIdentifier field
is_report_syncing_in_progressbooleanOptionalWhether installation report syncing is in progress. When true, deployment status may be temporarily inconsistent.
ma_device_group_idstringOptionalDevice group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.
softwareModelOptionalExpand Update a software deployment — response body — software
software_idstringRequired within parentThe ID of the software to deploy.
updated_atstringRequired within parentRecord update date

Referenced models: Update a software deployment — response body — software

Update a software deployment — response body — software
FieldTypePresenceDescription and constraints
$objectRootThe software being deployed. Expandable to get software name, icon, and metadata.

Expandable field
available_platformsarrayOptionalPlatforms this software is available on (macOS, Windows, etc).
available_platforms[]stringEach item
categorystringOptionalCategory of the software.
created_atstringRequired within parentRecord creation date
descriptionstringOptionalDescription of the software.
display_namestringOptionalCustom display name for the software.
icon_urlstringOptionalURL for the software icon.
idstringRequired within parentIdentifier field
namestringOptionalThe name of the software.
scopestringOptionalScope of the software (PUBLIC, CUSTOM, INTERNAL).
updated_atstringRequired within parentRecord update date

SDK function policy ID: rippling.rest_api.list_software_deployments. Catalog operation: list-software-deployments. 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: ["software-deployments.read"]

Provider entitlements: ["API_Tier_1"]

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.