---
title: "Test a connector URL"
method: POST
path: "/v1/connectors/probe"
tags: ["connectors"]
---

# Test a connector URL

`POST /v1/connectors/probe`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/connectors/probe`
- Auth: HTTP bearer

Test whether the platform can reach a given endpoint, behind the Test connection action used before creating a data source. The request is made from the server rather than the browser. Requests to private or internal network addresses are blocked.

Sends a GET to the URL from the server and returns the status and the start of the body. Rate limited to 20 calls a minute.

**Notes.**
- A URL that cannot be reached is not an HTTP error: the answer is 200 with `ok: false`, `status: 0` and `error`.
- A blocked private or internal address answers 400 with the `{ data: { ok: false, status: 0, error } }` body, not the usual error body.

## Request body

- object
  - `url` string, required: An http(s) URL on the public internet.
  - `token` string: Sent as `Authorization: Bearer <token>`. Not stored.

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `status` integer, required: HTTP status the URL answered with.
      - `ok` boolean, required: The status was 2xx.
      - `contentType` string, nullable, required
      - `sample` string, required: The first 4000 characters of the response body.
      - `truncated` boolean, required: The body was longer than `sample`.
    - object
      - `ok` false, required
      - `status` 0, required
      - `error` string, required: Why the request did not complete (network failure, timeout, or a blocked address).

## Other responses

- `400`: `bad_request`: the URL is not http(s). A private or internal address also answers 400, with the `data` body (`ok: false`, `status: 0`, `error`) instead of an error body.
- `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)