API リファレンス

すべてのエンドポイント、パラメータ、リクエスト/レスポンス形式、エラーコード。

ベース URL

https://api.ipfs.ninja

すべてのリクエストには X-Api-Key ヘッダーによる API キーが必要です。詳細は認証を参照してください。

エンドポイント

メソッド	パス	説明	ページ
POST	/upload/new	IPFS にファイルをアップロード	ファイル
GET	/upload/list	アップロード済みファイルを一覧表示	ファイル
GET	/file/:cid	CID でファイルメタデータを取得	ファイル
PUT	/files/:cid/name	ファイル名を変更	ファイル
PUT	/files/:cid/move	ファイルをフォルダに移動	フォルダ
POST	/pin	IPFS ネットワークから既存の CID をピン留め（スワームコネクトヒントに対応）	ピン留め
GET	/pin/:cid	ピン留めステータスを確認	ピン留め
POST	/folders	フォルダを作成	フォルダ
GET	/folders	フォルダを一覧表示	フォルダ
PUT	/folders/:folderId	フォルダを更新	フォルダ
DELETE	/folders/:folderId	フォルダを削除	フォルダ
POST	/folders/:folderId/snapshot	フォルダをディレクトリ CID にスナップショット	フォルダ
PUT	/folders/:folderId/cors	バケット単位の CORS 設定を構成	フォルダ
GET	/folders/:folderId/cors	バケット単位の CORS 設定を取得	フォルダ
DELETE	/folders/:folderId/cors	バケット単位の CORS 設定を削除	フォルダ
GET	/user/profile	ユーザープロフィールを取得	プロフィール
POST	/apikeys	API キーを作成	API キー
GET	/apikeys	API キーを一覧表示	API キー
DELETE	/apikeys/:key	API キーを削除	API キー
GET	/analytics	使用状況分析	アナリティクス
PUT	/gateway-settings	ゲートウェイ設定を更新	ゲートウェイ
POST	/gateway-tokens	ゲートウェイトークンを作成	ゲートウェイ
GET	/gateway-tokens	ゲートウェイトークンを一覧表示	ゲートウェイ
DELETE	/gateway-tokens/:prefix	ゲートウェイトークンを削除	ゲートウェイ
POST	/upload/signed-url	署名付きアップロードトークンを生成	署名付きトークン
GET	/signed-tokens	署名付きトークンを一覧表示	署名付きトークン
DELETE	/signed-tokens/:tokenId	署名付きトークンを取り消し	署名付きトークン
GET	/image/:cid	画像をオンザフライで最適化	画像最適化

デフォルトで CIDv1

アップロードとピン留めは、IPIP-0499 unixfs-v1-2025 プロファイルに従って最新の CIDv1（小さな単一ブロックのコンテンツには bafk…、より大きなファイルやディレクトリには bafy…）を返します。以前のアップロードによるレガシーな Qm… CID は、引き続きどこでも完全に解決可能です — Qm… は CID を受け付けるすべてのエンドポイントで有効な入力です。

S3 互換 API

任意の AWS SDK を使用して、IPFS Ninja 上でファイルのアップロードと管理を行えます。S3 クライアントのエンドポイントを https://s3.ipfs.ninja に向け、API キーを認証情報として使用してください。

https://s3.ipfs.ninja

S3 操作	説明
PutObject	IPFS にファイルをアップロード
GetObject	ファイルをダウンロード
HeadObject	ファイルメタデータを取得
DeleteObject	ファイルのピン留めを解除して削除
ListObjectsV2	プレフィックスフィルタリングでファイルを一覧表示
CreateMultipartUpload	マルチパートアップロードを開始（最大 5 GB）
UploadPart	パートをアップロード
CompleteMultipartUpload	マルチパートアップロードを完了
ListBuckets	ゲートウェイを一覧表示
CreateBucket	ゲートウェイを作成（バケット名はグローバルに一意で、既に使用されている場合は BucketAlreadyExists を返します）
DeleteBucket	ゲートウェイを削除
PutBucketCors	バケット単位の CORS ルールを設定（ブラウザ SDK を使用する場合に必須）
GetBucketCors	バケットの現在の CORS 設定を読み取り
DeleteBucketCors	バケットからすべての CORS ルールを削除

完全なドキュメント、コード例、移行ガイドについては、S3 互換性を参照してください。