Sign in

v1

latestOpenAPI 3.0.42026-08-0462132372.2 KB

Run action

Execute an action with the provided configuration and return results

post/v1/connect/{project_id}/actions/run

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 action component ID

versionstring nullable

Action component semantic version

external_user_idstring required

The external user ID

configured_propsConfiguredProps

The configured properties of the component

dynamic_props_idstring

The ID for dynamic props

Example request

{
  "version": "1.0.0"
}

Response

action ran

exportsobject

The key-value pairs resulting from calls to $.export

{"stackTrail":"components:schemas:RunActionResponse:properties:ret","oasType":"schema","type":"unknown","description":"The value returned by the action","nullable":true}
stash_idstring nullable

The ID of the File Stash