Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

source_slug
string
required

The slug of the source

Body

expires_in_seconds
integer
write-only
Required range: x >= 1
connector_config_fields
any | null

Restricts which connector config fields are visible/editable through this setup token. Null (the default) makes every field available, matching prior behavior. false hides a field (and its children); a list or object narrows availability to the named fields, recursing into their children with the same semantics.

action_url
string<uri> | null
write-only
Maximum string length: 2048

Response

201 - application/json
id
string<uuid>
required
read-only
token
string
required
read-only
expires_at
string<date-time>
required
read-only
purpose
enum<string>
required

Fixed at mint time from the source's state. A setup link (minted while the source awaits setup) stops working once that setup is over; an update link (minted for a source already created) works until it expires or is deleted.

  • setup - Setup
  • update - Update
Available options:
setup,
update
created_at
string<date-time>
required
read-only
created_by
integer
required
read-only

User that created this setup token (Expandable)

connector_config_fields
any | null

Restricts which connector config fields are visible/editable through this setup token. Null (the default) makes every field available, matching prior behavior. false hides a field (and its children); a list or object narrows availability to the named fields, recursing into their children with the same semantics.