Self-hosting Apidog
  1. Maintenance & Upgrades
Self-hosting Apidog
  • Introduction
    • Installation Overview
    • System Requirements
  • Licensing
    • Obtaining Apidog On-premises License
  • Deployment
    • Running Apidog on Docker
    • Running Apidog on Kubernetes
    • Running Apidog Multi-Container Deployment without Kubernetes
    • Privacy
  • Initial Setup
    • Admin Panel
    • Installing Apidog Client
    • Access Apidog Web
  • Configuration
    • Environment Variables
    • Configuring the application database
    • Configuring the application storage service
    • Configuring the git connection environment
    • Authentication Providers
      • Using LDAP for authentication
      • Using OKTA for authentication
      • Using OAuth2.0 for authentication
  • Maintenance & Upgrades
    • Updating Apidog
    • Backing up Apidog
    • License Renewal
    • System Data Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Maintenance & Upgrades

Updating Apidog

Instructions for updating to a new Apidog version.

Backing up your application database#

The application database stores all of your users, teams, projects, permissions, and other application data in Apidog. While it's unlikely that you'll need to revert to your current version, having a backup can provide peace of mind.
See Backing up Apidog.

Updating to the New Apidog Version#

1.
Back up your Apidog database.
2.
Stop the currently running Apidog Docker container(s).
3.
Pull the latest Apidog Docker image.
4.
(Optional) If using Docker Compose or Kubernetes, scale the deployment down to a single replica before starting the container with the new image.
5.
Update your existing script or deployment definition (e.g., docker-compose.yml, Kubernetes deployment definitions) to use the new Docker image tag.
6.
Deploy the updated configuration to start the new container.
Important Note on Replicas: Initial deployments and subsequent upgrades may involve database migrations. These migration tasks do not support concurrency. Therefore, if you are using a multi-replica deployment, you must first start a single container instance to perform the upgrade. Once the upgrade process is complete on the initial container, you can then proceed with a rolling update or scale out to your desired number of replicas.
Upon startup, the Apidog container will perform the update automatically. Once this process is complete, you will be running the latest version.

Rolling Back an Update#

As a best practice, we recommend performing regular backups, especially before an update. To roll back, restore your application database from a backup and then revert to the image version you were using prior to the update.

Desktop Client#

Please refer to the Installing the Apidog Client guide for the update instructions.
Modified at 2025-09-25 12:53:48
Previous
Using OAuth2.0 for authentication
Next
Backing up Apidog
Built with