User Manual

Projects - Archive project

ルート URL

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

説明

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.

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, its data will contain a URL to download the project archive.

curl -H "Authorization: Bearer fdslkjlk32j2l3kj2lkj2lkj323rr" -H "Content-Type: application/json" -X POST -d '{"branch_id": "99999999-9999-9999-9999-999999999999"}' https://playcanvas.com/api/projects/99999999/export

パラメータ

branch_id [optional]

The id of the branch. If no id is specified the master branch will be used.

応答のスキーマ

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

エラー

401

Unauthorized

403

Forbidden

404

Project not found

404

Owner not found

429

Too many requests

レート制限

このルートはstrictなレート制限を使用します。

This site is translated by the community. If you want to get involved visit this page