Sign in

v1

latestOpenAPI 3.0.02026-07-14184214216.1 KB
data

Run/schedule a connection.

Creates (if needed) and runs a connection with the given configuration. If a schedule is passed, the connector will be run on that schedule. (If there was an existing schedule, it will be overwritten.)

post/connectors/create

Request body

connectionIdstring

connection id for the request -- if not provided, connection will be created

connectionNamestring

connection name for the request -- if not provided, "Source Type timestamp" will be set

jobParamsNexusScheduledJobParams
obfuscatedUserstring

obfuscated user. Generally auth0 id.

{"stackTrail":"components:schemas:nexus.Request:properties:params","oasType":"schema","type":"unknown","description":"configuration parameters"}
runNowboolean

run the request immediately (only used when schedule is present, otherwise always runs)

skipNotificationboolean

skip sending notifications, will send notifications by the default

source'snowflake' | 'snowflakeSSO' | 'snowflakeLiveQuery' | 'snowflakeSSOLiveQuery' | 'google-analytics-data-api' | 'hubspot' | 'mysql' | 'postgres' | 'salesforce' | 'salesforceReport' | 'freshsales' | 'databricks' | 'databricksDeltaShare' | 'databricksLiveQuery' | 'bigquery' | 'awsathena' | 'awsredshift' | 'mssql' | 'clickhouse' | 'clickhouseLiveQuery'
userstring

user id for user performing action.

Response

OK

ConsentURLstring
{"stackTrail":"components:schemas:nexus.Response:properties:Error","oasType":"schema","type":"unknown"}
HandlesNexusHandleMap
Messagestring
Successboolean