Skip to main content

Check connection for the source connector.

This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. A token with ORG_ADMIN authority is required to call this API.

Path Parameters
  • sourceId string required

    The ID of the Source.

    Example: cef3ee201db947c5912551015ba0c679
Responses

The result of checking connection to the source connector with response from it.


Schema
  • id string

    ID of the source

  • name string

    Name of the source

  • status string

    Possible values: [SUCCESS, FAILURE]

    The status of the health check.

  • elapsedMillis integer

    The number of milliseconds spent on the entire request.

  • details object

    The document contains the results of the health check. The schema of this document depends on the type of source used.

Loading...