Rujukan API

Semua endpoint, parameter, format permintaan/respons, dan kod ralat.

Base URL

https://api.ipfs.ninja

Semua permintaan memerlukan API key melalui header X-Api-Key. Lihat Pengesahan untuk butiran.

Endpoint

Method	Path	Penerangan	Halaman
POST	/upload/new	Muat naik fail ke IPFS	Fail
GET	/upload/list	Senaraikan fail yang dimuat naik	Fail
GET	/file/:cid	Dapatkan metadata fail mengikut CID	Fail
PUT	/files/:cid/name	Namakan semula fail	Fail
PUT	/files/:cid/move	Alihkan fail ke dalam folder	Folder
POST	/pin	Semat CID sedia ada dari rangkaian IPFS (menyokong petunjuk swarm-connect)	Penyematan
GET	/pin/:cid	Semak status sematan	Penyematan
POST	/folders	Cipta folder	Folder
GET	/folders	Senaraikan folder	Folder
PUT	/folders/:folderId	Kemas kini folder	Folder
DELETE	/folders/:folderId	Padam folder	Folder
POST	/folders/:folderId/snapshot	Snapshot folder menjadi satu CID direktori	Folder
PUT	/folders/:folderId/cors	Tetapkan konfigurasi CORS per-bucket	Folder
GET	/folders/:folderId/cors	Dapatkan konfigurasi CORS per-bucket	Folder
DELETE	/folders/:folderId/cors	Buang konfigurasi CORS per-bucket	Folder
GET	/user/profile	Dapatkan profil pengguna	Profil
POST	/apikeys	Cipta API key	API Keys
GET	/apikeys	Senaraikan API key	API Keys
DELETE	/apikeys/:key	Padam API key	API Keys
GET	/analytics	Analitik penggunaan	Analitik
PUT	/gateway-settings	Kemas kini tetapan gateway	Gateways
POST	/gateway-tokens	Cipta gateway token	Gateways
GET	/gateway-tokens	Senaraikan gateway token	Gateways
DELETE	/gateway-tokens/:prefix	Padam gateway token	Gateways
POST	/upload/signed-url	Jana token muat naik bertandatangan	Token Bertandatangan
GET	/signed-tokens	Senaraikan token bertandatangan	Token Bertandatangan
DELETE	/signed-tokens/:tokenId	Batalkan token bertandatangan	Token Bertandatangan
GET	/image/:cid	Optimumkan imej secara on-the-fly	Pengoptimuman Imej

CIDv1 secara lalai

Muat naik dan sematan mengembalikan CIDv1 moden (bafk… untuk kandungan blok tunggal yang kecil, bafy… untuk fail dan direktori yang lebih besar) mengikut profil IPIP-0499 unixfs-v1-2025. CID Qm… lama daripada muat naik terdahulu kekal boleh diselesaikan sepenuhnya di mana-mana sahaja — Qm… adalah input yang sah untuk mana-mana endpoint yang menerima CID.

API Serasi S3

Gunakan mana-mana AWS SDK untuk memuat naik dan mengurus fail di IPFS Ninja. Arahkan klien S3 anda ke https://s3.ipfs.ninja dengan API key anda sebagai kelayakan.

https://s3.ipfs.ninja

S3 Operation	Penerangan
PutObject	Muat naik fail ke IPFS
GetObject	Muat turun fail
HeadObject	Dapatkan metadata fail
DeleteObject	Nyahsemat dan padam fail
ListObjectsV2	Senaraikan fail dengan penapisan awalan
CreateMultipartUpload	Mulakan muat naik berbilang bahagian (sehingga 5 GB)
UploadPart	Muat naik satu bahagian
CompleteMultipartUpload	Selesaikan muat naik berbilang bahagian
ListBuckets	Senaraikan gateway anda
CreateBucket	Cipta gateway (nama bucket adalah unik secara global — mengembalikan BucketAlreadyExists jika sudah digunakan)
DeleteBucket	Padam gateway
PutBucketCors	Konfigurasikan peraturan CORS per-bucket (diperlukan untuk penggunaan SDK pelayar)
GetBucketCors	Baca konfigurasi CORS semasa untuk sesuatu bucket
DeleteBucketCors	Buang semua peraturan CORS daripada bucket

Lihat Keserasian S3 untuk dokumentasi penuh, contoh kod, dan panduan migrasi.