Sign in

v1

latestOpenAPI 3.0.42026-08-0462132372.2 KB

Configure component prop

Retrieve remote options for a given prop for a component

post/v1/connect/{project_id}/components/configure

Headers

x-pd-environment'development' | 'production' required

The environment in which the server client is running

The environment in which the server client is running

Request body

idstring required

The component ID

versionstring nullable

Component semantic version

external_user_idstring required

The external user ID

prop_namestring required

The name of the prop to configure

blockingboolean

Whether this operation should block until completion

configured_propsConfiguredProps

The configured properties of the component

dynamic_props_idstring

The ID for dynamic props

pagenumber

Page number for paginated results

prev_contextobject

Previous context for pagination

querystring

Search query for filtering options

Example request

{
  "version": "1.0.0"
}

Response

component configuration started

stringOptionsstring[] nullable

Available options for the configured prop

contextobject nullable

New context after configuring the prop

errorsstring[]

Any errors that occurred during configuration