Sign in
Internal: Providers

Update Provider Setting

Update is_enabled and/or live_sync_mode for a single provider.

put/api/v1/oauth/providers/{provider}

Path parameters

providerstring required

Request body

is_enabledboolean nullable
live_sync_mode'pull' | 'webhook'
data_granularity'daily' | 'hourly' | 'raw'

How finely a provider's 24/7 data is stored.

DAILY — one aggregated value per day (server-side rollup). HOURLY — one aggregated value per hour (server-side rollup). RAW — every individual reading (no aggregation), where the provider supports it.

Response

Successful Response

providerstring required

Provider identifier (e.g., 'apple', 'garmin')

namestring required

Display name (e.g., 'Apple Health', 'Garmin')

has_cloud_apiboolean required

Whether provider uses cloud OAuth API

is_enabledboolean required

Whether provider is enabled by admin

icon_urlstring required

Relative URL to provider icon (e.g., '/static/provider-icons/garmin.svg'). Resolve against the API base URL.

live_sync_mode'pull' | 'webhook'
live_sync_configurableboolean

Whether the admin can switch live_sync_mode for this provider.

data_granularity'daily' | 'hourly' | 'raw'

How finely a provider's 24/7 data is stored.

DAILY — one aggregated value per day (server-side rollup). HOURLY — one aggregated value per hour (server-side rollup). RAW — every individual reading (no aggregation), where the provider supports it.

Changes

Changed in 1 of the 9 revisions of this API.2

  • e8a9270a1ee12See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog