connectors

Test a connector URL

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.
post/v1/connectors/probe

Request

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

Request body

urlstring required

An http(s) URL on the public internet.

tokenstring

Sent as Authorization: Bearer <token>. Not stored.

Response

Success.

Changes

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