How to deactivate an environment?

Valentina de la Nuez Martinez

Updated June 28, 2023 08:13

If you have environments you aren’t using, you may want to deactivate them to save resources for what you need. To deactivate an environment, you need to be an admin for the project or the given environment.

Note: Your default environment is protected. It can’t be deactivated through the Console or the CLI. To change which environment is the default, see all steps on how to change the default branch.

Deactivating the project results in the following:

The environment becomes inactive. Unless it’s reactivated, it’s no longer deployed and isn’t accessible from the web or via SSH.
All services running on this environment are deleted.
All data specific to the environment is deleted. If the environment is reactivated, it syncs data from its parent environment.

How to deactivate an environment

In the console:

Select the project with an environment you want to deactivate.
From the Environment menu, select the environment.
Click Settings.
In the row with Status, click Edit .
Select the checkbox to show you understand the consequences.
Click Deactivate & Delete Data.
Confirm your choice.

In the CLI:

Run the following command:

platform environment:deactivate ENVIRONMENT_NAME

Inactive environments still have branches in Git. To delete the branch entirely, run the following command:

git push origin --delete BRANCH_NAME

Do not hesitate to contact support if you are still not able to deactivate your environment or if you need further assistance.