Delete Environment
Table of Contents
Introduction
The Delete Environment job enables you to remove an existing environment within an organization. Deleting an environment will erase all associated data, configurations, and content, providing a comprehensive cleanup. This is particularly useful for retiring outdated environments or clearing up test environments.
Logging Details
During and after the execution of the Delete Environment job, detailed logging messages provide a record of the deletion process. Here is an example of the logging messages you may see:
| Message | Description |
|---|---|
Deleting environment data... | Indicates the start of the deletion process for the specified environment. |
Environment [TargetEnvironmentId] does not exist. | Notifies that the specified environment ID does not exist in the organization. |
Environment [TargetEnvironmentId] cannot be deleted because it is a main environment. | Alerts that the deletion process cannot proceed because the environment is a primary environment. |
Failed to delete [TargetEnvironmentId] environment. | Specifies that the environment could not be deleted due to an error. |
Failed to delete environment indices. Please contact the Codex team. | Notifies that an error occurred during the deletion of environment indices. |
Environment [TargetEnvironmentId] deleted successfully. | Confirms that the deletion of the environment was completed successfully. |
These logging messages give you full visibility into the Delete Environment job, helping you track the progress and outcome of each deletion type. Whether performing a full environment deletion or removing specific content, these logs ensure accuracy and traceability throughout the process.