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

Back up your Apidog database.

Stop the currently running Apidog Docker container(s).

Pull the latest Apidog Docker image.

(Optional) If using Docker Compose or Kubernetes, scale the deployment down to a single replica before starting the container with the new image.

Update your existing script or deployment definition (e.g., docker-compose.yml, Kubernetes deployment definitions) to use the new Docker image tag.

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

In general, regular backups (especially backups before updating), are the best policy, so we recommend reverting to a backup of your application database and then roll back to the previous image you used before the update.

Backing up your application database#

Updating to the New Apidog Version#

Rolling back an update#

Backing up your application database

Updating to the New Apidog Version

Rolling back an update