Metabase is a popular open-source business intelligence and data visualization platform that connects to multiple databases and allows users to create dashboards and reports. As a Metabase administrator, you may need to view all configured database connections for auditing, troubleshooting, or migration purposes.<\/p>\n\n\n\n
This article explains how to list all databases configured in Metabase using the API from the command line.<\/p>\n\n\n\n
Before proceeding, ensure you have:<\/p>\n\n\n\n
curl<\/code> installed on the server.<\/li>\n\n\n\njq<\/code> installed (optional, for formatted output).<\/li>\n\n\n\n- Network access to the Metabase application URL.<\/li>\n<\/ul>\n\n\n\n
Verify that Metabase is accessible:<\/p>\n\n\n\n$ curl -I http:\/\/localhost:3000<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nExpected output:<\/p>\n\n\n\n
HTTP\/1.1 200 OK<\/p>\n\n\n\n
Implementation<\/h2>\n\n\n\nStep 1: Generate a Metabase Session Token<\/h3>\n\n\n\n
Authenticate with Metabase and obtain a session token.<\/p>\n\n\n\n$ curl -X POST http:\/\/localhost:3000\/api\/session \\
-H “Content-Type: application\/json” \\
-d ‘{
“username”:”admin@example.com”,
“password”:”your_password”
}’<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nExample output:<\/p>\n\n\n\n{
“id”:”SESSION_TOKEN”
}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nCopy the session token value.<\/p>\n\n\n\n
Step 2: List All Configured Database<\/h3>\n\n\n\n
Run the following command:<\/p>\n\n\n\ncurl -X GET http:\/\/localhost:3000\/api\/database \\
-H “X-Metabase-Session: SESSION_TOKEN”<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nExample output:<\/p>\n\n\n\n{
“data”:[
{
“id”:1,
“name”:”Production MySQL”,
“engine”:”mysql”
},
{
“id”:2,
“name”:”Analytics PostgreSQL”,
“engine”:”postgres”
}
]
}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\nStep 3: Display Only Database Names<\/h3>\n\n\n\n
For a cleaner output, use:<\/p>\n\n\n\n$ curl -s http:\/\/localhost:3000\/api\/database \\
-H “X-Metabase-Session: SESSION_TOKEN” | jq -r ‘.data[].name’<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nExample output:<\/p>\n\n\n\nProduction MySQL
Analytics PostgreSQL
Reporting Database<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nStep 4: Display Database Names and Types<\/h3>\n\n\n\n