Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
dashboardId
string
forceRestart
boolean

Force restart even if already running

refreshDataOnly
boolean

Re-fetch data sources and reload without restarting the app

refreshSourceNames
string[]

If non-empty with refresh_data_only, only refresh these sources by name

refreshCodeOnly
boolean

Update code in-place via Streamlit's runOnSave without restarting the process

Response

Success

refreshedAt
string<date-time>

Spawn triggered asynchronously. Use CheckDashboardHealth to monitor status and get URLs. When spawn was triggered

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"