Test Source Connection

Test the connection to a source.

  • payload: Instance of TestSourceConnectionRequest model.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Tests the connection to a source. The request schema accepts a PostgreSQL source: type, params with the host, port, and db, and credentials.

When to use it

Use it to check connection details before you create or update a source.

Required parameters

  • type (body): the source type.
  • params (body): the PostgreSQL connection parameters: host, port, and db.
  • credentials (body): the PostgreSQL credentials.

Response

A successful call returns 200 OK. The response body is not documented.

Related: Create a source, Update a source, List sources

Body Params
string
enum
required
Allowed:
params
object
required
credentials
object
required
Responses

400

Bad Request

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json