KB489381:Guidance for Using the Project Unload and Delete REST API

To ensure system stability and data integrity, please follow this guidance when unloading or deleting projects: 

Perform Unload/Delete when all iServers are ready 

To ensure optimal system performance and integrity, we recommend waiting until all iServer pods are fully ready before performing an unload or delete operation on a project. This includes the following scenarios: 

• During iServer scale-in/scale-out operations
• During iServer upgrades
• When iServer is restarting or shutting down

 
This is because when iServers are starting, stopping, or restarting, they undergo a synchronization process to ensure metadata and system integrity across all loaded projects. For systems with a large number of projects, this process can be particularly resource-intensive. If a project is unloaded or deleted during this time, it can place added strain on the system, potentially affecting its responsiveness to other critical requests. 
 
 

Concurrent Operations Supported

Both new unload project API and delete project API supports concurrent requests, but projects are deleted one at a time in the backend 

Job Management for Unload/Delete 

 
For unloading or deleting projects, it will try its best to stop all jobs, including scheduled ones, But not all jobs are can be canceled during these operations. 
 
 

Using the New Unload Project API 

The updated Unload Project API includes the deleteSessions parameter. When set to true, it forcibly disconnects all active sessions and unloads the project across all nodes. 

Using the Delete Project API 

 
Similarly, the updated Delete Project API also supports the deleteSessions=true parameter. This ensures active sessions are terminated, the project is unloaded, and then deleted across all nodes. 
 

Understanding API Responses 

 
A 202 Accepted response from the Delete Project API does not confirm that the deletion process is complete. It only indicates the request was successfully submitted and the project ID is valid.
 

• To monitor progress, use the Get Project Status API: Get /api/monitors/projects/status?projectid={projectid}
• If a project remains unload_pending for more than 30 minutes, it will time out on the iServer side. After confirming the project is unloaded, the customer can trigger the delete project again.