Referensi API

Semua endpoint, parameter, format permintaan/respons, dan kode kesalahan.

URL Dasar

https://api.ipfs.ninja

Semua permintaan memerlukan API key melalui header X-Api-Key. Lihat Autentikasi untuk detail.

Endpoint

Metode	Path	Deskripsi	Halaman
POST	/upload/new	Unggah file ke IPFS	File
GET	/upload/list	Daftar file yang diunggah	File
GET	/file/:cid	Dapatkan metadata file berdasarkan CID	File
PUT	/files/:cid/name	Ganti nama file	File
PUT	/files/:cid/move	Pindahkan file ke dalam folder	Folder
POST	/pin	Sematkan CID yang ada dari jaringan IPFS (mendukung hint swarm-connect)	Pinning
GET	/pin/:cid	Periksa status pin	Pinning
POST	/folders	Buat folder	Folder
GET	/folders	Daftar folder	Folder
PUT	/folders/:folderId	Perbarui folder	Folder
DELETE	/folders/:folderId	Hapus folder	Folder
POST	/folders/:folderId/snapshot	Ambil snapshot folder menjadi satu CID direktori	Folder
PUT	/folders/:folderId/cors	Atur konfigurasi CORS per bucket	Folder
GET	/folders/:folderId/cors	Dapatkan konfigurasi CORS per bucket	Folder
DELETE	/folders/:folderId/cors	Hapus konfigurasi CORS per bucket	Folder
GET	/user/profile	Dapatkan profil pengguna	Profil
POST	/apikeys	Buat API key	API Keys
GET	/apikeys	Daftar API key	API Keys
DELETE	/apikeys/:key	Hapus API key	API Keys
GET	/analytics	Analitik penggunaan	Analytics
PUT	/gateway-settings	Perbarui pengaturan gateway	Gateway
POST	/gateway-tokens	Buat token gateway	Gateway
GET	/gateway-tokens	Daftar token gateway	Gateway
DELETE	/gateway-tokens/:prefix	Hapus token gateway	Gateway
POST	/upload/signed-url	Buat token unggah bertanda tangan	Token bertanda tangan
GET	/signed-tokens	Daftar token bertanda tangan	Token bertanda tangan
DELETE	/signed-tokens/:tokenId	Cabut token bertanda tangan	Token bertanda tangan
GET	/image/:cid	Optimasi gambar secara langsung	Optimasi Gambar

CIDv1 secara default

Unggahan dan pin mengembalikan CIDv1 modern (bafk… untuk konten satu-blok kecil, bafy… untuk file dan direktori yang lebih besar) mengikuti profil IPIP-0499 unixfs-v1-2025. CID Qm… lama dari unggahan sebelumnya tetap sepenuhnya dapat diresolusi di mana pun — Qm… adalah input yang valid untuk endpoint apa pun yang menerima CID.

API Kompatibel S3

Gunakan AWS SDK apa pun untuk mengunggah dan mengelola file di IPFS Ninja. Arahkan klien S3 Anda ke https://s3.ipfs.ninja dengan API key Anda sebagai kredensial.

https://s3.ipfs.ninja

Operasi S3	Deskripsi
PutObject	Unggah file ke IPFS
GetObject	Unduh file
HeadObject	Dapatkan metadata file
DeleteObject	Lepas pin dan hapus file
ListObjectsV2	Daftar file dengan filter prefix
CreateMultipartUpload	Mulai unggahan multipart (hingga 5 GB)
UploadPart	Unggah satu bagian
CompleteMultipartUpload	Selesaikan unggahan multipart
ListBuckets	Daftar gateway Anda
CreateBucket	Buat gateway (nama bucket unik secara global — mengembalikan BucketAlreadyExists jika sudah dipakai)
DeleteBucket	Hapus gateway
PutBucketCors	Konfigurasikan aturan CORS per bucket (diperlukan untuk penggunaan SDK browser)
GetBucketCors	Baca konfigurasi CORS saat ini untuk sebuah bucket
DeleteBucketCors	Hapus semua aturan CORS dari sebuah bucket

Lihat Kompatibilitas S3 untuk dokumentasi lengkap, contoh kode, dan panduan migrasi.