User Manual

Projects - Archive project

Route URL

POST https://playcanvas.com/api/projects/:id/export

Description

This will allow you to download a zip archive of your entire project. You can import that archive from your Projects Dashboard to create a new Project from that archive. More about importing projects here. You need an Organization plan to be able to download a project archive.

The request will start an archive job and the job details will be returned in the response. You can poll the job by id until its status is either 'complete' or 'error'. When the job is done, it's data will contain a URL to download the project archive.

Example

curl -H "Authorization: Bearer fdslkjlk32j2l3kj2lkj2lkj323rr" -H "Content-Type: application/json" -X POST https://playcanvas.com/api/projects/99999999/export

Response Schema

Status: 201 Created
{
    "id": int,
    "created_at": date,
    "modified_at": date,
    "status": "running" or "complete" or "error",
    "messages": list of strings,
    "data": {
      'project': {
         'id': int
      },
      "url": string
    }
}

Errors

401

Unauthorized

403

Forbidden

403

Invalid plan

403

User is not an admin of the organization

404

Project not found

404

Owner not found

429

Too many requests

Rate Limiting

This route uses a strict rate limit.