Studio On-Premise Documentation
Guides and reference material for Studio On-Premise.
Release Notes
Guides
Installing and Upgrading Swagger On-Premise
- Installing and Upgrading Swagger Studio On-PremiseChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Installing Swagger Studio On-Premise 2.xChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Native Helm InstallationChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Airgapped Helm InstallationSet up a Kubernetes cluster that meets the minimum requirements.
- Migration from an Existing Installation to HelmChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Install Swagger Studio On-Premise into Existing Kubernetes ClusterChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Minimum Requirements for Clustered InstallationSwagger Studio On-Premise can be installed into an existing Kubernetes or OpenShift cluster. A standard Swagger Studio On-Premise cluster deployment…
- Online Installation Into Existing Kubernetes ClusterChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Airgapped Installation Into Existing Kubernetes ClusterIf your Kubernetes cluster is not connected to the Internet, you can install Swagger On-Premise in airgapped (offline) mode.
- Online Installation Into Existing OpenShift ClusterThis guide contains the steps to install Swagger Studio On-Premise to an existing OpenShift cluster. When complete, the Swagger Studio application will be…
- Airgapped Installation Into Existing OpenShift ClusterIf your OpenShift cluster is not connected to the Internet, you can install Swagger On-Premise in airgapped (offline) mode.
- Install Swagger Studio On-Premise 2.x on a Virtual MachineChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- Minimum Requirements for VM InstallationSwaggerHub On-Premise 2.x can be installed on a virtual machine of your choice (Ubuntu, RHEL, Amazon Linux, and others). Both online and airgapped…
- VM (Embedded Cluster) - Online InstallationChanges to the Bitnami catalog took effect on August 28, 2025. Due to these changes, some Swagger Studio On-Prem users may need to take action. Find out…
- VM (Embedded Cluster) - Airgapped InstallationFollow this guide to install Swagger Studio On-Premise on a virtual machine that is not connected to the internet.
- Upgrading a 2.x installationChanges to the Bitnami catalog were announced recently and will take effect on August 28,. Due to these changes, some Swagger Studio On-Prem users may…
- Upgrading KOTSUpgrading KOTS
- 2.7 Migration Impact on LicensesThere is a risk of exceeding the Designer license limit while migrating to version 2.7.
- Bitnami PatchThis page outlines what approach you should take regarding the recent changes to the Bitnami catalog. You will learn:
- MongoDB Security Patch (CVE-2025-14847)The Swagger Studio On-prem 2.13.2 maintenance release addresses a detected MongoDB vulnerability.
- Migrating from Swagger Studio On-Premise 1.x to 2.7Swagger Studio On-Premise 2.7 uses a different installation method than 1.x versions. You may also need to contact your sales representative for an…
- Differences between Swagger Studio On-Premise 1.x and 2.xThis page summarizes the configuration changes between Swagger Studio On-Premise versions 1.x and 2.x. It is intended for administrators who are planning…
Managing Swagger On-Premise
- Managing Swagger Studio On-PremiseThis section of the documentation is for administrators who manage Swagger Studio On-Premise 2.x.
- Admin Console OverviewSwagger On-Premise 2.x uses Replicated KOTS to manage the installation, upgrades, and licensing. KOTS provides a web-based Admin Console that runs…
- Swagger Studio 2.x ConfigurationTo view or change Swagger Studio On-Premise configuration settings, use the Config tab of the Admin Console. The available settings are listed below.
- Proxy SettingsYou can configure an HTTP/S proxy server for Swagger Studio On-Premise that will be used for outbound connections. “Try it out” requests, importing…
- Routing and Ingress ConfigurationSwagger Studio On-Premise uses the swaggerhub-ingress Ingress resource to route external traffic to its internal services, directing each request to a…
- Deploy Configuration ChangesEvery time you change Swagger Studio On-Premise configuration settings on the Config page of the Admin Console, you need to deploy these changes for them…
- Maintenance OperationsThe Swagger Studio installation provides a CLI for various maintenance operations. The commands can be run via kubectl exec using the syntax given below.
- Add Custom Terms and ConditionsThis topic describes Terms & Conditions for Swagger On-Premise 2.5 and higher.
- Codegen TemplatesNote: This information applies to Swagger Studio On-Premise.
- Backup and RestoreYou can create backups to safeguard your Swagger On-Premise data and settings. These backups are helpful in the following situations:
- Backup and Restore with VeleroBackup and Restore
- Manual Backup and RestoreDuring restoration, the new instance may retain the IP address of the original instance.
- Migration of Databases: Internal to External and External to InternalDuring restoration, the new instance may retain the IP address of the original instance.
- Reset the Admin Console PasswordIf you forgot the password for the KOTS Admin Console, you can reset it to a new one.
- Graceful ShutdownYou can shut down Swagger Studio gracefully using the Embedded Kurl Cluster Operator (EKCO).
- TroubleshootingYou can create troubleshooting bundles for Swagger Studio technical support to assess product health and help with problems. Support bundles contain logs…
Single Sign-On
- Single Sign-OnThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
- Single Sign-On - OverviewThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
- How to: Single Sign-On With OktaThis information applies to Swagger Studio On-Premise 1.x. For Swagger Studio SaaS, click here.
- SAML 2.0 SettingsThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
- How to: Configure LDAP Authentication in Swagger Studio On-PremiseThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
- Migrate Existing Users to Single Sign-OnThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
- Single Sign-On FAQThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
- Troubleshoot Single Sign-On in Swagger Studio On-PremiseThis information applies to Swagger Studio On-Premise. For Swagger Studio SaaS, click here.
Usage Data Collection
Support Policy
Maintaining a 1.x Instance
- Maintaining a 1.x InstanceThis section of the documentation is intended for administrators who are managing an existing Swagger Studio On-Premise 1.x instance. The support policy…
- Upgrade Swagger Studio On-Premise to 1.29.3SmartBear provides only limited support for 1.x installations. For details, click here. If you are unable to upgrade to 2.x at this time, we recommend…
- Upgrade From Swagger Studio On-Premise 1.27-1.29.x to 1.29.2The upgrade to Swagger Studio On-Premise 1.29.2 from versions 1.27, 1.28, 1.29.0, or 1.29.1 is a direct in-place upgrade that involves running an upgrade…
- Upgrade From Swagger Studio On-Premise 1.22-1.26 to 1.29.2This guide explains how to upgrade an instance of Swagger Studio On-Premise v. 1.22–1.26 to 1.29.2.
- Upgrade From Swagger Studio On-Premise 1.21 to 1.29.2This guide explains how to upgrade an instance of Swagger Studio On-Premise v. 1.21.0-34 (this specific version) to 1.29.2.
- Upgrade From Swagger Studio On-Premise 1.19-1.20 to 1.29.2This guide explains how to upgrade an instance of Swagger Studio On-Premise v. 1.19.x–1.20.x to 1.29.2.
- Migrate Swagger Studio On-Premise to Ubuntu 20Earlier versions of Swagger Studio On-Premise (up to 1.26) were delivered with the Ubuntu 16 operating system. Newer versions use Ubuntu 20. Because of…
- Re-install Swagger Studio On-Premise 1.xSmartBear provides only limited support for 1.x installations. For details, click here. If you are unable to upgrade to 2.x at this time, you may still…
- Supported Platforms and Requirements for Swagger Studio On-PremiseSwagger Studio On-Premise can be installed on:
- Install Swagger Studio On-Premise on AWSSwagger Studio On-Premise can be deployed to the Amazon Web Services (AWS) cloud. You can launch an instance in the following ways:
- Deploy Swagger Studio On-Premise from AWS MarketplaceThis guide explains how you can set up a Swagger Studio On-Premise 1.x instance from the AWS Marketplace.
- Deploy Swagger Studio On-Premise from AWS EC2 ConsoleFollow these steps to launch a Swagger Studio On-Premise instance from the AWS EC2 console. The console allows you to fine-tune the configuration before…
- AWS Installation: Using a Load Balancer for SSL TerminationAfter deploying Swagger On-Premise to AWS, you may want to enable HTTPS access to the instance. There are two ways to set up HTTPS for Swagger On-Premise:
- Install Swagger Studio On-Premise on AzureSwagger Studio On-Premise is available in the Azure Marketplace, so that you can quickly deploy Swagger Studio to the Azure cloud.
- Install Swagger Studio On-Premise on VMware ESXiSwagger Studio On-Premise is available as an OVA image that can be deployed on VMware ESXi hosts. It is compatible with ESXi 5.1 and later.
- Install Swagger Studio On-Premise on VirtualBoxSwagger Studio On-Premise is distributed as a virtual machine that can be installed on VirtualBox. You can configure the Swagger Studio VM either via the…
- Activate Your LicenseThis information applies to Swagger On-Premise.
- Initial ConfigurationThis information applies to Swagger Studio On-Premise.
- Get Started With Swagger Studio On-PremiseAfter you activate the license and configure your Swagger Studio On-Premise instance, you can access the main application by pointing your browser to the…
- Configure Swagger Studio On-PremiseOnce your Swagger Studio On-Premise instance is up and running, you can change its configuration settings to suit your organization’s requirements.…
- Access the Admin CenterUse the Admin Center to change your Swagger Studio system configuration. Starting with v. 1.18.5, the Admin Center is accessible at:
- Default OrganizationIntroduced in Swagger Studio On-Premise 1.19.2.
- SSH Access to Swagger Studio On-PremiseNote: Introduced in Swagger Studio On-Premise 1.19.1.
- Change Your Swagger Studio On-Premise Domain or IP AddressA network administrator usually assigns a static IP address and, optionally, a user-friendly domain name to the Swagger Studio On-Premise VM. You will…
- Set a Static IP AddressNote: The described functionality is available in new installations of Swagger Studio On-Premise 1.18.3 and later. It is not available if you upgraded…
- Enable HTTPS/SSL in Swagger Studio On-PremiseSwagger Studio On-Premise is initially accessible over HTTP (non-secure connection). Secure HTTPS access can be achieved in two ways:
- Install an SSL Certificate to Swagger Studio On-PremiseNote: This guide explains SSL certificate setup for Swagger Studio On-Premise v. 1.19.2 and later. If you use an earlier version, see here.
- Install an SSL Certificate to Swagger Studio On-Premise 1.18.5–1.19.1Note: This guide explains the SSL certificate setup for Swagger Studio On-Premise v. 1.18.5–1.19.1. If you use a later version, see here.
- HTTPS Setup Using a Load BalancerThe Swagger Studio web application is initially accessible over HTTP. HTTPS can be implemented in two ways, one of which is to put a load balancer with…
- Change Authentication MethodSwagger Studio On-Premise supports several ways of authenticating users:
- Disable Account Sign-UpsIntroduced in Swagger Studio On-Premise 1.20.0.
- Add Custom Terms & ConditionsIntroduced in Swagger On-Premise 1.22.0.
- Configure SMTP ServerNote: This information applies to Swagger Studio On-Premise.
- Time Synchronization via NTPIntroduced in Swagger Studio On-Premise 1.19.2.
- Certificate ManagerIntroduced in Swagger Studio On-Premise 1.19.2.
- Use Custom Codegen TemplatesNote: This information applies to Swagger Studio On-Premise.
- Change Admin Password in Swagger Studio On-PremiseThe admin password used to access the Admin Center can be changed from the main Swagger Studio application.
- Configure GitHub IntegrationNote: This information applies to Swagger Studio On-Premise.
- Configure GitLab IntegrationNote: This information applies to Swagger Studio On-Premise.
- Configure Bitbucket Server IntegrationNote: This guide is for Swagger Studio On-Premise 1.21.0 and later. If you are using an earlier version, see here.
- Configure Bitbucket Integration (Swagger Studio On-Premise 1.20.x and earlier)Note: This guide is for Swagger Studio On-Premise versions up to 1.20.x. If you are using a later version, see here.
- Configure Azure DevOps IntegrationsSwagger Studio On-Premise integrates with Azure DevOps Services (formerly VSTS) and Azure DevOps Server (formerly TFS). The target Azure DevOps…
- Configure Azure API Management IntegrationTo use the Azure API Management integration, you first need to configure an application in Azure that will authenticate requests from your Swagger Studio…
- License ManagementNote: This information applies to Swagger Studio On-Premise 1.18.1 and later.
- Online License ActivationThis information applies to Swagger Studio On-Premise.
- Offline License ActivationIntroduced in Swagger Studio On-Premise 1.18.1.
- Manage Users in Swagger Studio On-PremiseWhen you install Swagger Studio On-Premise, you create an administrator user. You will use this user to log in for the first time and configure your…
- Add Users in Swagger On-PremiseSwagger Studio allows users to sign up themselves. An administrator and organization owners can invite new users by email, but the users need to sign up…
- View All UsersTo see all the users registered in your Swagger Studio On-Premise instance, use the License page of the Admin Center:
- Delete Users in Swagger Studio On-PremiseA Swagger Studio On-Premise administrator may need to delete inactive users to free up license seats for the other users. For example, you can delete the…
- Backup and RecoveryNote: This information applies to Swagger On-Premise.
- Create VM SnapshotsNote: This information applies to Swagger Studio On-Premise.
- Back Up and Restore Swagger On-Premise Data and ConfigurationYou can back up your Swagger On-Premise data and configuration. These backups are useful in the following cases:
- Automated Data BackupsNote: This information applies to Swagger On-Premise.
- MaintenanceThis documentation is for Swagger Studio On-Premise 1.x.
- Download System LogsThis information applies to Swagger Studio On-Premise.
- Restart Swagger Studio On-PremiseSometimes, you may need to restart your Swagger Studio On-Premise instance. A restart is typically required:
- Run Maintenance Scripts in Swagger Studio On-PremiseWhile working on your support requests, SmartBear Support may send you maintenance scripts to apply custom configurations or to perform maintenance tasks…
- Useful VirtualBox CommandsIf you run Swagger Studio On-Premise on VirtualBox, here are some useful commands to manage your Swagger Studio VM.