POST
/
api
/
databases
Creates a new database connection.
curl --request POST \
  --url http://127.0.0.1:47334/v1/api/api/databases \
  --header 'Content-Type: application/json' \
  --data '{
  "database": {
    "name": "<string>",
    "engine": "<string>",
    "parameters": {
      "user": "<string>",
      "password": "<string>",
      "host": "<string>",
      "port": "<string>",
      "database": "<string>"
    }
  }
}'
{
  "name": "<string>",
  "engine": "<string>",
  "type": "<string>"
}

The REST API playground can currently only be used with MindsDB running locally at http://127.0.0.1:47334. Support for MindsDB Cloud is in progress. In the meantime, check out our SQL example for how to use the REST API with MindsDB Cloud.

Body

application/json
​
database
object

Response

200
application/json

The created database

​
name
string
​
engine
string

Handler used to create this database (e.g. postgres)

​
type
string

Type of database (data | project | system)