{"id":10381,"date":"2026-06-19T19:59:43","date_gmt":"2026-06-19T14:29:43","guid":{"rendered":"https:\/\/pheonixsolutions.com\/blog\/?p=10381"},"modified":"2026-06-19T20:00:48","modified_gmt":"2026-06-19T14:30:48","slug":"how-to-add-a-database-to-metabase-via-cli-using-the-rest-api","status":"publish","type":"post","link":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/","title":{"rendered":"How to Add a Database to Metabase via CLI Using the REST API"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Introduction<\/h2>\n\n\n\n<p>Metabase is a popular open-source business intelligence platform that allows users to connect various databases and create dashboards and reports. While databases are typically added through the Metabase web interface, administrators can automate the process using the Metabase REST API and command-line tools such as <code>curl<\/code>.<\/p>\n\n\n\n<p>This article explains how to add a database to Metabase from the command line.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Prerequisites<\/h2>\n\n\n\n<p>Before proceeding, ensure the following:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Metabase is installed and running.<\/li>\n\n\n\n<li>Administrator access to Metabase.<\/li>\n\n\n\n<li>API key or username and password for authentication.<\/li>\n\n\n\n<li>Database connection details (host, port, database name, username, and password).<\/li>\n\n\n\n<li><code>curl<\/code> installed on the server.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Implementation<\/h2>\n\n\n\n<p><strong>Step 1: Generate an API Key<\/strong><\/p>\n\n\n\n<p>Navigate to:<\/p>\n\n\n\n<p><strong>Admin Settings \u2192 Authentication \u2192 API Keys<\/strong><\/p>\n\n\n\n<p>Generate an API key and note it for use in API requests.<\/p>\n\n\n\n<p><strong>Step 2: Create the Database Connection<\/strong><\/p>\n\n\n\n<p>Execute the following command to add a MySQL database:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>curl -X POST http:\/\/metabase.example.com\/api\/database \\\n-H \"Content-Type: application\/json\" \\\n-H \"x-api-key: YOUR_API_KEY\" \\\n-d '{\n  \"engine\": \"mysql\",\n  \"name\": \"Production MySQL\",\n  \"details\": {\n    \"host\": \"IP ADDRESS\",\n    \"port\": 3306,\n    \"dbname\": \"employees\",\n    \"user\": \"dbuser\",\n    \"password\": \"dbpassword\"\n  }\n}'\n<\/code><\/pre>\n\n\n\n<p><strong>Step 3: Verify the Database<\/strong><\/p>\n\n\n\n<p>Retrieve the list of databases configured in Metabase:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>curl -X GET http:\/\/metabase.example.com\/api\/database \\\n-H \"x-api-key: YOUR_API_KEY\"\n<\/code><\/pre>\n\n\n\n<p>The output will display all configured databases.<\/p>\n\n\n\n<p><strong>Step 4: Update an Existing Database<\/strong><\/p>\n\n\n\n<p>To modify an existing database configuration:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>curl -X PUT http:\/\/metabase.example.com\/api\/database\/2 \\\n-H \"Content-Type: application\/json\" \\\n-H \"x-api-key: YOUR_API_KEY\" \\\n-d '{\n  \"name\": \"Updated MySQL Database\"\n}'\n<\/code><\/pre>\n\n\n\n<p>Replace <code>2<\/code> with the database ID.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Conclusion<\/h2>\n\n\n\n<p>Although Metabase does not provide a dedicated CLI command for adding databases, administrators can automate the process using the REST API and command-line tools such as <code>curl<\/code>. This approach is particularly useful for scripting, infrastructure automation, and managing multiple Metabase instances.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Introduction Metabase is a popular open-source business intelligence platform that allows users to connect various databases and create dashboards and reports. While databases are typically added through the Metabase web interface, administrators can automate the process using the Metabase REST API and command-line tools such as curl. This article explains&hellip; <a href=\"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/\" class=\"more-link read-more\" rel=\"bookmark\">Continue Reading <span class=\"screen-reader-text\">How to Add a Database to Metabase via CLI Using the REST API<\/span><i class=\"fa fa-arrow-right\"><\/i><\/a><\/p>\n","protected":false},"author":496,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_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_post_was_ever_published":false},"categories":[1],"tags":[],"class_list":{"0":"post-10381","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"hentry","6":"category-uncategorized","7":"h-entry","9":"h-as-article"},"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.8 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Pheonix Solutions - We Empower Your Business Growth<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Pheonix Solutions - We Empower Your Business Growth\" \/>\n<meta property=\"og:description\" content=\"Introduction Metabase is a popular open-source business intelligence platform that allows users to connect various databases and create dashboards and reports. While databases are typically added through the Metabase web interface, administrators can automate the process using the Metabase REST API and command-line tools such as curl. This article explains&hellip; Continue Reading How to Add a Database to Metabase via CLI Using the REST API\" \/>\n<meta property=\"og:url\" content=\"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/\" \/>\n<meta property=\"og:site_name\" content=\"PHEONIXSOLUTIONS\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/PheonixSolutions-209942982759387\/\" \/>\n<meta property=\"article:published_time\" content=\"2026-06-19T14:29:43+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-06-19T14:30:48+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/pheonixsolutions.com\/blog\/wp-content\/uploads\/2016\/09\/PX2.png\" \/>\n\t<meta property=\"og:image:width\" content=\"3837\" \/>\n\t<meta property=\"og:image:height\" content=\"2540\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Saikrishna Areddy\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@pheonixsolution\" \/>\n<meta name=\"twitter:site\" content=\"@pheonixsolution\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Saikrishna Areddy\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/\"},\"author\":{\"name\":\"Saikrishna Areddy\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#\\\/schema\\\/person\\\/fc35ace8f00b25766f1de0edb110bbe1\"},\"headline\":\"How to Add a Database to Metabase via CLI Using the REST API\",\"datePublished\":\"2026-06-19T14:29:43+00:00\",\"dateModified\":\"2026-06-19T14:30:48+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/\"},\"wordCount\":225,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#organization\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/\",\"name\":\"Pheonix Solutions - We Empower Your Business Growth\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#website\"},\"datePublished\":\"2026-06-19T14:29:43+00:00\",\"dateModified\":\"2026-06-19T14:30:48+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to Add a Database to Metabase via CLI Using the REST API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/\",\"name\":\"Pheonix Solutions\",\"description\":\"We Empower Your Business Growth\",\"publisher\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#organization\",\"name\":\"PheonixSolutions\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/wp-content\\\/uploads\\\/2016\\\/12\\\/logo.png\",\"contentUrl\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/wp-content\\\/uploads\\\/2016\\\/12\\\/logo.png\",\"width\":454,\"height\":300,\"caption\":\"PheonixSolutions\"},\"image\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.facebook.com\\\/PheonixSolutions-209942982759387\\\/\",\"https:\\\/\\\/x.com\\\/pheonixsolution\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/#\\\/schema\\\/person\\\/fc35ace8f00b25766f1de0edb110bbe1\",\"name\":\"Saikrishna Areddy\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/219fb50fa61a168b58a5e704d05058f958504aa8324675172185e3f0e8b3fd24?s=96&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/219fb50fa61a168b58a5e704d05058f958504aa8324675172185e3f0e8b3fd24?s=96&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/219fb50fa61a168b58a5e704d05058f958504aa8324675172185e3f0e8b3fd24?s=96&r=g\",\"caption\":\"Saikrishna Areddy\"},\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/blog\\\/author\\\/saikrishna\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Pheonix Solutions - We Empower Your Business Growth","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/","og_locale":"en_US","og_type":"article","og_title":"Pheonix Solutions - We Empower Your Business Growth","og_description":"Introduction Metabase is a popular open-source business intelligence platform that allows users to connect various databases and create dashboards and reports. While databases are typically added through the Metabase web interface, administrators can automate the process using the Metabase REST API and command-line tools such as curl. This article explains&hellip; Continue Reading How to Add a Database to Metabase via CLI Using the REST API","og_url":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/","og_site_name":"PHEONIXSOLUTIONS","article_publisher":"https:\/\/www.facebook.com\/PheonixSolutions-209942982759387\/","article_published_time":"2026-06-19T14:29:43+00:00","article_modified_time":"2026-06-19T14:30:48+00:00","og_image":[{"width":3837,"height":2540,"url":"https:\/\/pheonixsolutions.com\/blog\/wp-content\/uploads\/2016\/09\/PX2.png","type":"image\/png"}],"author":"Saikrishna Areddy","twitter_card":"summary_large_image","twitter_creator":"@pheonixsolution","twitter_site":"@pheonixsolution","twitter_misc":{"Written by":"Saikrishna Areddy","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/#article","isPartOf":{"@id":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/"},"author":{"name":"Saikrishna Areddy","@id":"https:\/\/pheonixsolutions.com\/blog\/#\/schema\/person\/fc35ace8f00b25766f1de0edb110bbe1"},"headline":"How to Add a Database to Metabase via CLI Using the REST API","datePublished":"2026-06-19T14:29:43+00:00","dateModified":"2026-06-19T14:30:48+00:00","mainEntityOfPage":{"@id":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/"},"wordCount":225,"commentCount":0,"publisher":{"@id":"https:\/\/pheonixsolutions.com\/blog\/#organization"},"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/","url":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/","name":"Pheonix Solutions - We Empower Your Business Growth","isPartOf":{"@id":"https:\/\/pheonixsolutions.com\/blog\/#website"},"datePublished":"2026-06-19T14:29:43+00:00","dateModified":"2026-06-19T14:30:48+00:00","breadcrumb":{"@id":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/pheonixsolutions.com\/blog\/how-to-add-a-database-to-metabase-via-cli-using-the-rest-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/pheonixsolutions.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to Add a Database to Metabase via CLI Using the REST API"}]},{"@type":"WebSite","@id":"https:\/\/pheonixsolutions.com\/blog\/#website","url":"https:\/\/pheonixsolutions.com\/blog\/","name":"Pheonix Solutions","description":"We Empower Your Business Growth","publisher":{"@id":"https:\/\/pheonixsolutions.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/pheonixsolutions.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/pheonixsolutions.com\/blog\/#organization","name":"PheonixSolutions","url":"https:\/\/pheonixsolutions.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/pheonixsolutions.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/pheonixsolutions.com\/blog\/wp-content\/uploads\/2016\/12\/logo.png","contentUrl":"https:\/\/pheonixsolutions.com\/blog\/wp-content\/uploads\/2016\/12\/logo.png","width":454,"height":300,"caption":"PheonixSolutions"},"image":{"@id":"https:\/\/pheonixsolutions.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/PheonixSolutions-209942982759387\/","https:\/\/x.com\/pheonixsolution"]},{"@type":"Person","@id":"https:\/\/pheonixsolutions.com\/blog\/#\/schema\/person\/fc35ace8f00b25766f1de0edb110bbe1","name":"Saikrishna Areddy","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/219fb50fa61a168b58a5e704d05058f958504aa8324675172185e3f0e8b3fd24?s=96&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/219fb50fa61a168b58a5e704d05058f958504aa8324675172185e3f0e8b3fd24?s=96&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/219fb50fa61a168b58a5e704d05058f958504aa8324675172185e3f0e8b3fd24?s=96&r=g","caption":"Saikrishna Areddy"},"url":"https:\/\/pheonixsolutions.com\/blog\/author\/saikrishna\/"}]}},"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p7F4uM-2Hr","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/10381","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=10381"}],"version-history":[{"count":3,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/10381\/revisions"}],"predecessor-version":[{"id":10389,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/10381\/revisions\/10389"}],"wp:attachment":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/media?parent=10381"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/categories?post=10381"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/tags?post=10381"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}