Skip to content

Rippling: Extract existing metadata components — response body

Extract existing metadata components: response body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Extract existing metadata components — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
component_configsarrayRequired within parentReadable component configs for the selected roots. Dependencies the caller cannot read are omitted, so the result may not be deployable as-is.
component_configs[]ModelEach itemExpand Extract existing metadata components — response body — component configs item
context_completebooleanOptionalFor search-backed extraction, whether contextual expansion completed without warnings or unreadable components being omitted.
context_warningsarrayOptionalWarnings from search-backed contextual expansion.
context_warnings[]stringEach item
dependency_graphobjectRequired within parentSerialized dependency graph for the extracted package.
Additional keys: allowed
external_managed_dependenciesarrayOptional
external_managed_dependencies[]objectEach itemExternal managed dependency.
Additional keys: allowed
install_orderarrayRequired within parentTopological install order for the extracted package.
install_order[]objectEach itemComponent identifier.
Additional keys: allowed
root_componentsarrayRequired within parentComponents selected as extraction roots.
root_components[]ModelEach itemExpand Extract existing metadata components — response body — root components item

Referenced models: Extract existing metadata components — response body — component configs item, Extract existing metadata components — response body — root components item

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.