Scheduling

Schedule Sync

Schedules a sync for a specific connection type and ID based on user-provided cron args.

Parameters:

  • connection_type: The type of the connection (e.g., 'snowflake', 'bigquery').
  • connection_id: The ID of the connection
  • cron_args: The schedule for the sync (e.g., {"hour": 3, "minute": 0}).
  • user: The current authenticated admin user.
post/api/schedule_sync

Request

  • Base URL: https://app.getdot.ai (the document declares no server; this is the origin it was published from)
  • URL: https://app.getdot.ai/api/schedule_sync
  • Auth: one of:
    • API key in header X-API-KEY
    • API key in cookie Authorization
    • OAuth 2 (password, token URL /api/auth/token)

Request body

connection_typestring required
connection_idstring required
cron_argsobject required
refresh_samplesboolean

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.