PIpipedream

Reload component props

Reload the prop definition based on the currently configured props

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

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/{project_id}/components/props
  • 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

blockingboolean

Whether this operation should block until completion

configured_propsConfiguredProps

The configured properties of the component

dynamic_props_idstring

The ID for dynamic props

Example request

{
  "version": "1.0.0"
}

Response

component props reloaded

errorsstring[]

Any errors that occurred during configuration

Example response

{
  "dynamicProps": {
    "configurableProps": [
      {
        "app": "github"
      }
    ]
  }
}

Changes

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