PIpipedream

Configure component prop

Retrieve remote options for a given prop for a component

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

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/{project_id}/components/configure
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://api.pipedream.com/v1/oauth/token

Headers

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

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

Changes

No recorded changes to this operation across all 4 revisions of this API.