Skip to main content

Test configuration for source connector



This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. A token with ORG_ADMIN authority is required to call this API.


Path Parameters

    sourceId stringrequired

    The ID of the Source

    Example: cef3ee201db947c5912551015ba0c679


The result of testing source connector configuration with response from it.

    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.