Back to Mindsdb

List Data Sources

docs/minds/rest_api/list_datasources.mdx

26.1.01.7 KB
Original Source

This API endpoint lists all connected Datasources using the GET method.

Body

None.

Response

<ResponseField name="connection_data" type="object" required>

Details for connecting to the data source including host, port, user, password, etc.

</ResponseField> <ResponseField name="description" type="string">

Optional description of the datasource.

</ResponseField> <ResponseField name="engine" type="string" required>

The engine type of the datasource (e.g., postgres).

</ResponseField> <ResponseField name="name" type="string" required>

The unique name of the datasource.

</ResponseField> <ResponseField name="tables" type="array">

List of tables that are accessible from this datasource.

</ResponseField>

Authorization

A valid API key must be passed in the Authorization header:

Authorization: Bearer MINDS_API_KEY

Generate your API key here.

Path Parameters

None.

<RequestExample>
shell
curl --request GET \
     --url 'https://mdb.ai/api/datasources' \
     --header 'Authorization: Bearer MINDS_API_KEY'
python
from minds.client import Client

client = Client("MINDS_API_KEY", "https://mdb.ai/")

client.datasources.list()
</RequestExample> <ResponseExample>
json
[
    {
        "connection_data": {
            "database": "demo",
            "host": "samples.mindsdb.com",
            "password": "demo_password",
            "port": "5432",
            "schema": "demo_data",
            "user": "demo_user"
        },
        "description": "House sales data",
        "engine": "postgres",
        "name": "my_datasource",
        "tables": ["house_sales"]
    }
]
</ResponseExample>