data-sources

Test a data source config

Validate a connector configuration without saving it. Returns { ok: true, preview } on success or { ok: false, error } on failure, so a misconfigured feed can be caught before it is created.

Runs the connector once with a config that is not saved. A connector failure is NOT an HTTP error: the answer is 200 with ok: false and the reason. Rate limited to 20 calls a minute.

post/v1/data-sources/test

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/data-sources/test
  • Auth: HTTP bearer

Request body

typestring required
configobject

Connector settings (JSON). The keys depend on type. Credentials are encrypted at rest and every later read shows them as ••••••••.

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.