Test Data Source Configuration

Test Data Source Configuration

This endpoint allows you to test if a data source has been configured correctly.

More specifically, the API will attempt to connect to the data source as it would when the PAIS backend performs an indexing. This allows you to verify whether the stored settings and credentials are correct and the PAIS system can connect to the data source APIs.

You can use this endpoint, for example, to ensure that updates to settings or credentials will allow the next indexing to access the data source.

To test the configuration before creating the data source, you can instead use the /test-connection endpoint.

Request
URI
GET
https://{api_host}/api/v1/control/data-sources/test-connection/{data_source_id}
COPY
Path Parameters
string
data_source_id
Required

data_source_id

Authentication
This operation uses the following authentication methods.
Responses
200

Outcome of validating the configuration of the data source.

Returns DataSourceTestConnectionResponse of type(s) application/json 
{
    "status": "string",
    "detail": "string"
}
string
status
Required

Data source connectivity result.

Possible values are : CONNECTIVITY_RESULT_SUCCESS, CONNECTIVITY_RESULT_CONNECTION_FAILED,
string
detail
Optional

Details about the connectivity result, if any.


404

Invalid data source ID.

Operation doesn't return any data structure

422

Validation Error

Returns HTTPValidationError of type(s) application/json 
"HTTPValidationError Object"
array of object
detail
Optional

detail


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/control/data-sources/test-connection/{data_source_id}
On This Page
Data Sources Operations
GET
Test Data Source Configuration
POST
Test Connectivity
GET
List Data Sources
POST
Create Data Source
GET
Get Data Source
PATCH
Update Data Source
DELETE
Delete Data Source
GET
List Knowledge Bases Linked To Data Source