Admin API：メディア

メディアをアップロードする、一覧にする、変える、削除する操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

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

操作	メソッドとパス
メディアの一覧	GET /admin/api/spaces/{slug}/media
メディアをアップロードする	POST /admin/api/spaces/{slug}/media
メディアを取得する	GET /admin/api/spaces/{slug}/media/{id}
メディアの代替テキストとタグを変える	PATCH /admin/api/spaces/{slug}/media/{id}
メディアを削除する	DELETE /admin/api/spaces/{slug}/media/{id}
メディアを使っているエントリー	GET /admin/api/spaces/{slug}/media/{id}/usages

メディアの一覧

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

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

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
q	クエリ	文字列			ファイル名・代替テキスト・タグで探す
tag	クエリ	文字列			このタグを持つもの
kind	クエリ	文字列			image か file
limit	クエリ	整数		0 以上	件数（既定 50、最大 100）
cursor	クエリ	文字列			前の応答の nextCursor

返る値：

状態	本文
200	ListResponse（application/json）

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

例：

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

メディアをアップロードする

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

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

パラメーター：

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

リクエストの本文（multipart/form-data）：

名前	型	必須	決まり	説明
alt	文字列か null			代替テキスト
file	ファイル	○		ファイル
tags	文字列か null			タグ（文字列の JSON の配列、["news","top"]）

返る値：

状態	本文
201	MediaView（application/json）

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

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/media" \
  -H "Authorization: Bearer <アクセストークン>" \
  -F "file=@<ファイル>"

メディアを取得する

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

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

パラメーター：

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

返る値：

状態	本文
200	MediaView（application/json）

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

例：

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

メディアの代替テキストとタグを変える

PATCH /admin/api/spaces/{slug}/media/{id}

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

パラメーター：

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

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

名前	型	必須	決まり	説明
alt	文字列か null			代替テキスト
tags	文字列の配列か null			タグ（文字列の配列）。渡すと置き換える

返る値：

状態	本文
200	MediaView（application/json）

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

例：

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

メディアを削除する

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

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

パラメーター：

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

返る値：

状態	本文
204	なし

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

例：

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

メディアを使っているエントリー

GET /admin/api/spaces/{slug}/media/{id}/usages

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

パラメーター：

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

返る値：

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

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

例：

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