Skip to Content
OpenETL
ReferenceAPISource Service

Discover source

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

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

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

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 discovers it. Unset: the default.

Response Body

OK

application/json
  1. response
catalog?

Catalog is what a source's Discover found.

Example Request
curl -X POST 'http://localhost:8080/v1/workspaces/string/sources/string:discover' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "catalog": {    "streams": [      {        "name": "string",        "primaryKey": [          "string"        ],        "cursorField": "string",        "replay": "REPLAY_UNSPECIFIED",        "columns": [          {            "name": "string",            "type": "string",            "nullable": true          }        ],        "syncModes": [          "SYNC_MODE_UNSPECIFIED"        ]      }    ],    "version": "string",    "discoverTime": "2019-08-24T14:15:22Z"  }}