Admin API：スペースの書き出し

スペースの中身を 1 つのファイルに書き出す操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。

操作	メソッドとパス
スペースの書き出しの一覧	GET /admin/api/spaces/{slug}/exports
スペースの書き出しを始める	POST /admin/api/spaces/{slug}/exports
書き出しを 1 件取得する	GET /admin/api/spaces/{slug}/exports/{id}
書き出しの記録と ZIP を消す	DELETE /admin/api/spaces/{slug}/exports/{id}
書き出した ZIP をダウンロードする	GET /admin/api/spaces/{slug}/exports/{id}/download

スペースの書き出しの一覧

スペースの書き出し（新しい順に 20 件）

GET /admin/api/spaces/{slug}/exports

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ

返る値：

状態	本文
200	TransferList（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/exports" \
  -H "Authorization: Bearer <アクセストークン>"

スペースの書き出しを始める

書き出しを始める。同じスペースの書き出しが待っているか動いていれば 409。

POST /admin/api/spaces/{slug}/exports

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ

リクエストの本文（application/json）：

名前	型	必須	決まり	説明
mediaFiles	真偽値か null			メディアの中身を入れるか（既定は入れる）

返る値：

状態	本文
202	TransferView（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/exports" \
  -H "Authorization: Bearer <アクセストークン>" \
  -H "Content-Type: application/json" \
  -d '{}'

書き出しを 1 件取得する

GET /admin/api/spaces/{slug}/exports/{id}

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
200	TransferView（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/exports/<id>" \
  -H "Authorization: Bearer <アクセストークン>"

書き出しの記録と ZIP を消す

書き出しの記録と ZIP を消す。待っているか動いているものは消せない（409）

DELETE /admin/api/spaces/{slug}/exports/{id}

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
204	なし

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X DELETE "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/exports/<id>" \
  -H "Authorization: Bearer <アクセストークン>"

書き出した ZIP をダウンロードする

書き出した ZIP を返す。終わっていない、期限が来た、消したものは 404。

GET /admin/api/spaces/{slug}/exports/{id}/download

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
200	ファイル（application/zip）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/exports/<id>/download" \
  -H "Authorization: Bearer <アクセストークン>"