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\ncurl -s http:\/\/localhost:3000\/api\/database \\
-H “X-Metabase-Session: SESSION_TOKEN” | jq -r ‘.data[] | “(.name) – (.engine)”‘<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nExample output:<\/p>\n\n\n\nProduction MySQL – mysql
Analytics PostgreSQL – postgres
Reporting Database – sqlserver<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nVerification<\/h2>\n\n\n\n
Confirm that:<\/p>\n\n\n\n
\n- The API request returns a list of configured databases.<\/li>\n\n\n\n
- Database names are displayed correctly.<\/li>\n\n\n\n
- Database engines (MySQL, PostgreSQL, SQL Server, etc.) are shown as expected.<\/li>\n<\/ul>\n\n\n\n
If the API returns an authentication error, generate a new session token and try again.<\/p>\n\n\n\n
Conclusion<\/h2>\n\n\n\n
Using the Metabase API, administrators can quickly list all configured database connections from the command line. This method is useful for auditing, migration planning, troubleshooting, and validating database connectivity without logging in to the Metabase web interface. Regularly reviewing configured databases helps maintain an organized and secure Metabase environment.<\/p>\n","protected":false},"excerpt":{"rendered":"
Introduction Metabase is a popular open-source business intelligence and data visualization platform that connects to multiple databases and allows users […]<\/p>\n","protected":false},"author":496,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[1019,1042,1040,1022],"tags":[180,993],"class_list":["post-11006","post","type-post","status-publish","format-standard","hentry","category-cloud-aws","category-databases","category-linux","category-web-architecture","tag-database","tag-metabase","psol-cat-cloud-aws"],"jetpack_publicize_connections":[],"jetpack_shortlink":"https:\/\/wp.me\/phn2x7-2Rw","jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/11006","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/users\/496"}],"replies":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/comments?post=11006"}],"version-history":[{"count":1,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/11006\/revisions"}],"predecessor-version":[{"id":11161,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/11006\/revisions\/11161"}],"wp:attachment":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/media?parent=11006"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/categories?post=11006"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/tags?post=11006"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}