CINXE.COM

<!doctype html> <html lang="en" dir="ltr" class="plugin-pages plugin-id-default" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">mittwald Developer Portal</title><meta data-rh="true" property="og:title" content="mittwald Developer Portal"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://developer.mittwald.de/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="de"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" name="description" content="The mittwald Developer Portal provides developers with the resources they need to integrate mittwald products into their own applications using our API."><meta data-rh="true" property="og:description" content="The mittwald Developer Portal provides developers with the resources they need to integrate mittwald products into their own applications using our API."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://developer.mittwald.de/"><link data-rh="true" rel="alternate" href="https://developer.mittwald.de/" hreflang="en"><link data-rh="true" rel="alternate" href="https://developer.mittwald.de/de/" hreflang="de"><link data-rh="true" rel="alternate" href="https://developer.mittwald.de/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",(function(){void 0===window.docusaurus&&insertBanner()}))</script><link rel="alternate" type="application/rss+xml" href="/changelog/rss.xml" title="mittwald Developer Portal RSS Feed"> <link rel="alternate" type="application/atom+xml" href="/changelog/atom.xml" title="mittwald Developer Portal Atom Feed"><link rel="stylesheet" href="/assets/css/styles.15bf2aa1.css"> <script src="/assets/js/runtime~main.2c9a6cb4.js" defer="defer"></script> <script src="/assets/js/main.4d26cca0.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/mittwald-logo.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/mittwald-logo.svg" alt="mittwald" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/mittwald-logo.svg" alt="mittwald" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Developer Portal</b></a><a class="navbar__item navbar__link" href="/docs/v2/api/intro/">API</a><a class="navbar__item navbar__link" href="/docs/v2/cli/">CLI</a><a class="navbar__item navbar__link" href="/docs/v2/category/platform/">Platform</a><a class="navbar__item navbar__link" href="/docs/v2/contribution/">Contribution</a><a class="navbar__item navbar__link" href="/docs/v2/reference/">Reference</a><a class="navbar__item navbar__link" href="/changelog/">Changelog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/mittwald/developer-portal" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/de/" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="de">Deutsch</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div><header class="hero hero--primary heroBanner_qdFl"><div class="container"><h1 class="hero__title">mittwald Developer Portal</h1><div class="buttons_AeoN"><a class="button button--success button--lg" href="/docs/v2/api/intro/">Get started with our API</a></div></div></header><main class="index"><section class="featureRow_Yn__"><div class="container"><div class="row"><div class="col col--4"><div><div class="introHeader_vD0d"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="tabler-icon tabler-icon-cloud-network flow--icon flow--icon--size-m" focusable="false" role="img" aria-hidden="true"><path d="M3 20h7"></path><path d="M14 20h7"></path><path d="M10 20a2 2 0 1 0 4 0a2 2 0 0 0 -4 0"></path><path d="M12 16v2"></path><path d="M8 16.004h-1.343c-2.572 -.004 -4.657 -2.011 -4.657 -4.487c0 -2.475 2.085 -4.482 4.657 -4.482c.393 -1.762 1.794 -3.2 3.675 -3.773c1.88 -.572 3.956 -.193 5.444 1c1.488 1.19 2.162 3.007 1.77 4.769h.99c1.913 0 3.464 1.56 3.464 3.486c0 1.927 -1.551 3.487 -3.465 3.487h-2.535"></path></svg><h3>Deploy your software easily</h3></div><p>Deploy your applications and services to our platform with ease. We support a variety of programming languages, frameworks and databases.</p></div></div><div class="col col--4"><div class="padding--md feature_CLW0"><h3>Platform features</h3><p>Our platform provides a variety of features to help you deploy your applications and services:</p><ul><li><strong>Runtime environments</strong><br><a href="/docs/v2/platform/workloads/php/">PHP</a> | <a href="/docs/v2/platform/workloads/nodejs/">Node.js</a> | <a href="/docs/v2/platform/workloads/python/">Python</a> | <a href="https://github.com/mittwald/feature-requests/issues/1" target="_blank" rel="noopener noreferrer">Docker (planned)</a></li><li><strong>Databases</strong><br><a href="/docs/v2/platform/databases/mysql/">MySQL</a> | <a href="/docs/v2/platform/databases/redis/">Redis</a> | <a href="/docs/v2/platform/databases/opensearch/">OpenSearch</a></li></ul><p>Missing features? <a href="https://github.com/mittwald/feature-requests/issues" target="_blank" rel="noopener noreferrer">Request them here!</a></p></div></div><div class="col col--4"><div class="padding--md feature_CLW0"><h3>Tooling and Integration</h3><p>We provide a variety of tools, integrations and tutorials to help you deploy your applications and services:</p><ul><li><strong>Local development</strong><br><a href="/cli/">CLI</a> | <a href="/docs/v2/platform/development/ddev/">DDEV <div class="badge badgeNew_qErG"><span>NEW</span></div></a></li><li><strong>Deployment and Provisioning</strong><br><a href="/docs/v2/platform/deployment/deployer/">Deployer</a> | <a href="/docs/v2/platform/deployment/typo3surf/">TYPO3 Surf</a> | <a href="https://github.com/mittwald/terraform-provider-mittwald" target="_blank" rel="noopener noreferrer">Terraform</a></li></ul></div></div></div></div></section><section class="featureRow_Yn__ variant_FcGt"><div class="container"><div class="row"><div class="col col--4"><div><div class="introHeader_vD0d"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="tabler-icon tabler-icon-plug-connected flow--icon flow--icon--size-m" focusable="false" role="img" aria-hidden="true"><path d="M7 12l5 5l-1.5 1.5a3.536 3.536 0 1 1 -5 -5l1.5 -1.5z"></path><path d="M17 12l-5 -5l1.5 -1.5a3.536 3.536 0 1 1 5 5l-1.5 1.5z"></path><path d="M3 21l2.5 -2.5"></path><path d="M18.5 5.5l2.5 -2.5"></path><path d="M10 11l-2 2"></path><path d="M13 14l-2 2"></path></svg><h3>Automate and integrate with our API</h3></div><p>Our API allows you to manage your mittwald products and services programmatically. You can use it to automate tasks, integrate our services into your own applications, or build entirely new applications on top of our platform.</p></div></div><div class="col col--4"><div class="padding--md feature_CLW0"><h3>API Documentation</h3><p>All endpoints and parameters of our API at a glance, including human readable references and machine readable specifications in the OpenAPI format.</p><ul><li><strong>v1 API (Customer Center)</strong><br><a href="/docs/v1/reference/">Reference</a> | <a href="https://api.mittwald.de/v1/openapi.json" target="_blank" rel="noopener noreferrer">OpenAPI 3.0 specification</a></li><li><strong>v2 API (mStudio)</strong><br><a href="/docs/v2/reference/">Reference</a> | <a href="/docs/v2/api/intro/">Introduction</a> | <a href="https://api.mittwald.de/openapi" target="_blank" rel="noopener noreferrer">OpenAPI 3.0 specification</a></li></ul><p>We also provide tutorials and examples to help you get started with our API. <a href="/docs/v2/category/how-tos/">Check them out!</a></p></div></div><div class="col col--4"><div class="padding--md feature_CLW0"><h3>SDKs and Libraries</h3><p>Make it easy for yourself and use one of our SDKs or libraries to integrate our API into your application:</p><ul><li><a href="/cli/">mittwald CLI</a></li><li><a href="/docs/v2/api/sdks/php/">mittwald PHP SDK</a></li><li><a href="/docs/v2/api/sdks/javascript/">mittwald JavaScript SDK</a> (Node.js + browser)</li><li><a href="/docs/v2/api/sdks/go/">mittwald Go SDK</a> <div class="badge badgeNew_qErG"><span>NEW</span></div></li></ul><p><strong>Have you built your own library that uses our API? <a href="https://github.com/mittwald/developer-portal/issues/new?&labels=suggestion&template=suggestion.md" target="_blank" rel="noopener noreferrer">Let us know, and we'll link it here!</a> 馃挋</strong></p></div></div></div></div></section><section class="featureRow_Yn__"><div class="container"><div class="row"><div class="col col--4"><div><div class="introHeader_vD0d"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="tabler-icon tabler-icon-heart-handshake flow--icon flow--icon--size-m" focusable="false" role="img" aria-hidden="true"><path d="M19.5 12.572l-7.5 7.428l-7.5 -7.428a5 5 0 1 1 7.5 -6.566a5 5 0 1 1 7.5 6.572"></path><path d="M12 6l-3.293 3.293a1 1 0 0 0 0 1.414l.543 .543c.69 .69 1.81 .69 2.5 0l1 -1a3.182 3.182 0 0 1 4.5 0l2.25 2.25"></path><path d="M12.5 15.5l2 2"></path><path d="M15 13l2 2"></path></svg><h3>Build your own extensions for the mStudio marketplace</h3></div><p>The mStudio marketplace is a platform for developers to build and distribute their own extensions. You can create extensions that integrate with the mStudio API and add new features to the mStudio platform.</p></div></div><div class="col col--4"><div class="padding--md feature_CLW0"><h3>Integrating extensions</h3><p>These guides will help you get started with building extensions for the mStudio marketplace.</p><ul><li><a href="/docs/v2/contribution/">Introduction and overview</a></li><li><a href="/docs/v2/contribution/overview/concepts/authentication/">Integrating with mStudio access controls</a></li><li><a href="/docs/v2/category/reference/">API and webhook specifications</a></li></ul><p>Check the complete documentation. <a href="/docs/v2/contribution/">Read more!</a></p></div></div><div class="col col--4"><div class="padding--md feature_CLW0"><h3>Contributor tools</h3><p>These guides will help you get started with building extensions for the mStudio marketplace.</p><ul><li><strong>Flow</strong>: The mittwald design system and React component library.<br><a href="https://github.com/mittwald/flow" target="_blank" rel="noopener noreferrer">GitHub</a> | <a href="https://mittwald.github.io/flow" target="_blank" rel="noopener noreferrer">Documentation</a></li></ul><p><strong>Coming soon: 馃獎</strong></p><ul><li><strong>Extension Deployment Manager</strong>: A utility application to help you implement the required extension webhooks and manage the lifecycle of your extension installations.</li></ul></div></div></div></div></section></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/v2/api/intro/">API usage</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/v2/category/platform/">Platform</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/v2/category/sdks-and-libraries/">SDKs and Libraries</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/v2/reference/">Reference</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/mittwald/developer-portal/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feedback<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://agenturen.mittwald.de" target="_blank" rel="noopener noreferrer" class="footer__link-item">Agency Hub (german)<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.mittwald.de/agb" target="_blank" rel="noopener noreferrer" class="footer__link-item">Terms of Service<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.mittwald.de/datenschutz" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy Policy<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.mittwald.de/impressum" target="_blank" rel="noopener noreferrer" class="footer__link-item">Legal<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright 漏 2025 Mittwald CM Service GmbH & Co. KG. Built with Docusaurus.</div></div></div></footer></div> </body> </html>