Rippling: Start an async metadata deployment run

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

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.create_metadata_deployment_run

Provider route: POST /metadata/deployment-runs/. Alter supplies the connection’s credentials and routing.

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"]["createMetadataDeploymentRun"]>[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.createMetadataDeploymentRun(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_metadata_deployment_run(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional
`body`	Model	Required within parent	Expand Validate metadata components — request body — body

Referenced models: Validate metadata components — request body — body

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	Additional keys: not allowed
`created_at`	JSON	Optional
`created_at (anyOf 1)`	string	Alternative	Format: date-time
`created_at (anyOf 2)`	null	Alternative
`error`	JSON	Optional
`error (anyOf 1)`	object	Alternative	Additional keys: allowed
`error (anyOf 2)`	null	Alternative
`expires_at`	JSON	Optional
`expires_at (anyOf 1)`	string	Alternative	Format: date-time
`expires_at (anyOf 2)`	null	Alternative
`finished_at`	JSON	Optional
`finished_at (anyOf 1)`	string	Alternative	Format: date-time
`finished_at (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Metadata run id.
`progress`	object	Required within parent	Additional keys: allowed
`result`	JSON	Optional
`result (anyOf 1)`	object	Alternative	Additional keys: allowed
`result (anyOf 2)`	null	Alternative
`retry_after_ms`	JSON	Required within parent
`retry_after_ms (anyOf 1)`	integer	Alternative	Suggested client polling delay in milliseconds. Minimum: 0
`retry_after_ms (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`started_at`	JSON	Optional
`started_at (anyOf 1)`	string	Alternative	Format: date-time
`started_at (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Known values: queued, running, succeeded, failed, cancelled, expired
`terminal`	boolean	Required within parent	Whether the run has reached a terminal status.
`type`	string	Required within parent	Known values: validation, deployment
`updated_at`	JSON	Optional
`updated_at (anyOf 1)`	string	Alternative	Format: date-time
`updated_at (anyOf 2)`	null	Alternative

Policy, approvals and errors

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

Provider entitlements: ["Metadata_Platform_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page