Hi Teams,
We are introducing a new, improved set of Asynchronous Project Export APIs under the tag “Async Project Export”, and formally deprecating the existing /project/export API.
Deprecation Notice
The current /project/export API is now deprecated due to:
- Performance limitations for large projects
- Blocking behavior that impacts UI responsiveness during long-running exports
- Lack of visibility into export progress and failure reasons
Please migrate to the new asynchronous APIs described below.
Recommended Approach — Async Project Export
All new APIs are available under the following base path:
/configservice/project-export
These APIs are designed to support non-blocking, background exports with:
- Trackable status
- Detailed audit logs
- Reliable file download after completion
- Explicit cleanup via a delete endpoint
1) Initiate Export — Start an Async Export
POST /configservice/project-export
This endpoint starts a project export in the background and returns an exportId that can be used to track and retrieve the export.
Request Body
{
"projectId": "string",
"tag": "string"
}
Successful Response (200)
{
"message": "Export initiated successfully",
"exportId": 123
}
The exportId returned here must be used for all subsequent operations related to this export.
2) Check Export Status
POST /configservice/project-export/status
Use this endpoint to monitor the progress of an export.
Request Body
{
"exportId": 123
}
Possible Status Values
"In Progress"— Export is still running"Complete"— Export finished successfully"Failed"— Export encountered an error
3) Download Export (After Completion)
GET /configservice/project-export/export/{id}/download
Once the export status is "Complete", this endpoint returns the exported project as a ZIP file.
Response Codes
| Status | Description |
|---|---|
| 200 | ZIP file returned successfully |
| 400 | Export is still in progress |
| 404 | Export ID not found |
| 500 | Internal server error |
4) Fetch Audit Logs for an Export
POST /configservice/project-export/audit-logs
This endpoint provides detailed logs for a specific export, useful for debugging failures or understanding processing steps.
Request Body
{
"exportId": 123
}
5) Delete an Export
POST /configservice/project-export/delete
Deletes the export record and all associated exported files.
Request Body
{
"exportId": 123
}
Why this approach is better
| Capability | Old /project/export |
New Async APIs |
|---|---|---|
| Non-blocking execution | No | Yes |
| Trackable status | No | Yes |
| Detailed audit logs | No | Yes |
| Safe retries | No | Improved |
| Explicit cleanup | No | Yes |
Action Required
If you are currently using /project/export, please migrate to /configservice/project-export and its associated endpoints.
If you need assistance with migration or have integration questions, please reach out to the platform team or raise a query in the community channel.