---
title: "Test a data source config"
method: POST
path: "/v1/data-sources/test"
tags: ["data-sources"]
---

# Test a data source config

`POST /v1/data-sources/test`

## Request

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

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.

## Request body

- object
  - `type` string, required
  - `config` object: Connector settings (JSON). The keys depend on `type`. Credentials are encrypted at rest and every later read shows them as `••••••••`.

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `ok` true, required
      - `preview` string, required: The fetched data as JSON text, cut to 2000 characters.
    - object
      - `ok` false, required
      - `error` string, required: Why the connector failed, or that no connector has this `type`.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `429`: More than 20 calls in a minute.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)