SyncUpdate schedule

Update schedule

Change the sync frequency, and optionally the hour it runs at, for a connection. Scheduled frequencies are pushed to Airbyte; manual switches the connection to manual triggering. Requires an agency key (ak_).

Sending sync_frequency alone KEEPS the connection's existing sync_hour_utc rather than resetting it to the default, so changing cadence never silently moves a client's sync to a different time of day. The response returns runs_at_utc, the concrete hours this schedule fires at.

curl -X PATCH "https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/connections/example_string/schedule" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "sync_frequency": "manual",
  "sync_hour_utc": 8
}'
{
  "success": true,
  "sync_frequency": "manual",
  "sync_hour_utc": 8,
  "runs_at_utc": [
    2,
    8,
    14,
    20
  ]
}
PATCH
/connections/{id}/schedule
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.

Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
Bearer Token
Bearer Tokenstring
Required

Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.

Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.
path
idstring
Required

Mythic connection record identifier (the local UUID, not the Airbyte connection ID).

Content-Typestring
Required

The media type of the request body

Options: application/json
sync_frequencystring
Required

Sync cadence. 24h, 12h and 6h schedule automatic syncs at sync_hour_utc; manual disables them, and is the DEFAULT — a connection created without this field does not sync on a schedule.

Options: manual, 24h, 12h, 6h
sync_hour_utcinteger

Hour of day, UTC, the cadence is anchored to. Defaults to 2 when unset. Sub-daily cadences anchor on hour % interval, so the hour you ask for is always one of the run times and the runs stay evenly spaced — 6h at 8 runs at 02:00, 08:00, 14:00 and 20:00. Ignored when sync_frequency is manual.

Min: 0 • Max: 23
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.

header
Authorizationstring
Required

Bearer token. Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.

Path Parameters

idstring
Required

Mythic connection record identifier (the local UUID, not the Airbyte connection ID).

Body

application/json
sync_frequencystring
Required

Sync cadence. 24h, 12h and 6h schedule automatic syncs at sync_hour_utc; manual disables them, and is the DEFAULT — a connection created without this field does not sync on a schedule.

Allowed values:manual24h12h6h
sync_hour_utcinteger

Hour of day, UTC, the cadence is anchored to. Defaults to 2 when unset. Sub-daily cadences anchor on hour % interval, so the hour you ask for is always one of the run times and the runs stay evenly spaced — 6h at 8 runs at 02:00, 08:00, 14:00 and 20:00. Ignored when sync_frequency is manual.

Example:
8

Responses

successboolean
sync_frequencystring

Sync cadence. 24h, 12h and 6h schedule automatic syncs at sync_hour_utc; manual disables them, and is the DEFAULT — a connection created without this field does not sync on a schedule.

Allowed values:manual24h12h6h
sync_hour_utcinteger

Hour of day, UTC, the cadence is anchored to. Defaults to 2 when unset. Sub-daily cadences anchor on hour % interval, so the hour you ask for is always one of the run times and the runs stay evenly spaced — 6h at 8 runs at 02:00, 08:00, 14:00 and 20:00. Ignored when sync_frequency is manual.

runs_at_utcinteger[]

The hours (UTC) this schedule actually fires at — empty for manual. Provided so a caller never has to decode a cron expression to tell a client when their data lands.