---
title: "Configure component prop"
method: POST
path: "/v1/connect/{project_id}/components/configure"
---

# Configure component prop

`POST /v1/connect/{project_id}/components/configure`

Retrieve remote options for a given prop for a component

## Headers

- `x-pd-environment` 'development' | 'production', required — The environment in which the server client is running

## Request body

- ConfigurePropOpts — Request options for configuring a component's prop
  - `id` string, required — The component ID
  - `version` string, nullable — Component semantic version
  - `external_user_id` string, required — The external user ID
  - `prop_name` string, required — The name of the prop to configure
  - `blocking` boolean — Whether this operation should block until completion
  - `configured_props` ConfiguredProps — The configured properties of the component
  - `dynamic_props_id` string — The ID for dynamic props
  - `page` number — Page number for paginated results
  - `prev_context` object — Previous context for pagination
  - `query` string — Search query for filtering options

## Response `200`

component configuration started

- ConfigurePropResponse — Response received after configuring a component's prop
  - `options` union[], nullable — Available options (with labels) for the configured prop
    - union
      - PropOption — A configuration option for a component's prop
        - `label` string, required — The human-readable label for the option
        - `value` union, required — The value of a prop option
          - string
          - integer
          - boolean
      - PropOptionNested — A configuration option for a component's prop (nested under `__lv`)
        - `__lv` PropOption, required — A configuration option for a component's prop
          - `label` string, required — The human-readable label for the option
          - `value` union, required — The value of a prop option
            - string
            - integer
            - boolean
  - `stringOptions` string[], nullable — Available options for the configured prop
  - `observations` Observation[], nullable
    - `err` ObservationError — Details about an observed error message
      - `name` string — The name of the error/exception
      - `message` string — The error message
      - `stack` string — The stack trace of the error
    - `k` string, required — The source of the log (e.g. `console.log`)
    - `msg` string — The log message
    - `ts` number, required — The time at which the log was produced, as milliseconds since the epoch
  - `context` object, nullable — New context after configuring the prop
  - `errors` string[] — Any errors that occurred during configuration

## Other responses

- `202` — Async operation started
- `429` — too many requests

---

[API](https://skmtc.net/pipedream/apis/pipedream-rest-api.md) · [All operations](https://skmtc.net/pipedream/apis/pipedream-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedream/pipedream-rest-api/versions/c25dbf225c49/schema)