Admin API：スペース

スペースを作る、取得する、削除する操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
スペースの一覧	GET /admin/api/spaces
スペースを作り、作成者をオーナーにする	POST /admin/api/spaces
スペースを取得する	GET /admin/api/spaces/{slug}
スペースを消す	DELETE /admin/api/spaces/{slug}

スペースの一覧

メンバーになっているスペース。環境の管理者にはすべてのスペース。

GET /admin/api/spaces

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

返る値：

状態	本文
200	SpaceView の配列（application/json）

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

例：

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

スペースを作り、作成者をオーナーにする

スペースを作り、作成者をオーナーにする。環境の管理者だけができる。

POST /admin/api/spaces

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

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

名前	型	必須	決まり	説明
name	文字列	○		表示名
slug	文字列	○		スラッグ（URL に入る ID）

返る値：

状態	本文
201	SpaceView（application/json）

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

例：

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

スペースを取得する

メンバーでないスペースは、存在を知られないよう 404 にする。

GET /admin/api/spaces/{slug}

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

パラメーター：

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

返る値：

状態	本文
200	SpaceView（application/json）

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

例：

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

スペースを消す

service.manage（初期ロールでは owner）が要る。メンバーでない環境の管理者もできる（ほかの操作と同じく owner として扱う）

DELETE /admin/api/spaces/{slug}

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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