Skip to main content

Read project Signals settings

MethodPath
GET/v1/signals/settings

Shared authentication, project scope, and response conventions.

Reads the settings that apply to the caller's project. This can be the project's own Signals tenant or a tenant shared with other projects.

Requirement or resultDetails
Access policysignals_config:read
Success200 with tenant and settings
tenantproject when the project has its own tenant; shared when settings are shared across projects.

The settings object contains:

FieldMeaning
episodicAlertsWhether Signals alert episodes are enabled. An absent switch is read as false.
synchronousModeThe tenant's operational synchronous-mode flag. Changing it requires Super Admin.
throttleLimitnull means use the Signals default; 0 means no throttle limit; a positive integer is the configured limit.
curl --request GET \
--url 'https://api.sandbox.ovok.com/v1/signals/settings' \
--header "Authorization: Bearer ${OVOK_TOKEN}"