Skip to Content
OpenETL
ReferenceAPISource Service

Check source

Runs the source's Check on a runner of the data plane, and waits for it.

POST
/v1/workspaces/{workspace}/sources/{source}:check

Runs the source's Check on a runner of the data plane, and waits for it.

Path Parameters

workspace*string

The workspace id.

source*string

The source id.

Request Body

application/json
  1. body
name?string
dataPlane?string

The data plane whose runner checks it. Unset: the default.

Response Body

OK

application/json
  1. response
result?

CheckResult is a connector's answer to Check. A connector without a check of its own only validates its config.

Example Request
curl -X POST 'http://localhost:8080/v1/workspaces/string/sources/string:check' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "result": {    "ok": true,    "code": "string",    "message": "string",    "version": "string"  }}