API referencia

Minden végpont, paraméter, kérés/válasz formátum és hibakód.

Alap URL

https://api.ipfs.ninja

Minden kéréshez API kulcs szükséges az X-Api-Key fejlécen keresztül. Részletekért lásd a Hitelesítés oldalt.

Végpontok

Metódus	Útvonal	Leírás	Oldal
POST	/upload/new	Fájl feltöltése az IPFS-re	Fájlok
GET	/upload/list	Feltöltött fájlok listázása	Fájlok
GET	/file/:cid	Fájl metaadatok lekérése CID alapján	Fájlok
PUT	/files/:cid/name	Fájl átnevezése	Fájlok
PUT	/files/:cid/move	Fájl áthelyezése mappába	Mappák
POST	/pin	Meglévő CID rögzítése az IPFS hálózatról (swarm-connect hint-eket is támogat)	Rögzítés
GET	/pin/:cid	Rögzítés állapotának ellenőrzése	Rögzítés
POST	/folders	Mappa létrehozása	Mappák
GET	/folders	Mappák listázása	Mappák
PUT	/folders/:folderId	Mappa frissítése	Mappák
DELETE	/folders/:folderId	Mappa törlése	Mappák
POST	/folders/:folderId/snapshot	Mappa pillanatkép készítése egy könyvtár CID-be	Mappák
PUT	/folders/:folderId/cors	Bucketenkénti CORS konfiguráció beállítása	Mappák
GET	/folders/:folderId/cors	Bucketenkénti CORS konfiguráció lekérése	Mappák
DELETE	/folders/:folderId/cors	Bucketenkénti CORS konfiguráció eltávolítása	Mappák
GET	/user/profile	Felhasználói profil lekérése	Profil
POST	/apikeys	API kulcs létrehozása	API kulcsok
GET	/apikeys	API kulcsok listázása	API kulcsok
DELETE	/apikeys/:key	API kulcs törlése	API kulcsok
GET	/analytics	Használati analitika	Analitika
PUT	/gateway-settings	Gateway beállítások frissítése	Gateway-ek
POST	/gateway-tokens	Gateway token létrehozása	Gateway-ek
GET	/gateway-tokens	Gateway tokenek listázása	Gateway-ek
DELETE	/gateway-tokens/:prefix	Gateway token törlése	Gateway-ek
POST	/upload/signed-url	Aláírt feltöltési token generálása	Aláírt tokenek
GET	/signed-tokens	Aláírt tokenek listázása	Aláírt tokenek
DELETE	/signed-tokens/:tokenId	Aláírt token visszavonása	Aláírt tokenek
GET	/image/:cid	Kép optimalizálása menet közben	Képoptimalizálás

CIDv1 alapértelmezetten

A feltöltések és rögzítések modern CIDv1-et adnak vissza (bafk… kis, egyblokkos tartalomhoz, bafy… nagyobb fájlokhoz és könyvtárakhoz) az IPIP-0499 unixfs-v1-2025 profil szerint. A korábbi feltöltésekből származó örökölt Qm… CID-ek mindenhol továbbra is teljes mértékben feloldhatók — a Qm… bármely CID-et elfogadó végpont érvényes bemenete.

S3-kompatibilis API

Használjon bármilyen AWS SDK-t fájlok feltöltésére és kezelésére az IPFS Ninja-n. Irányítsa az S3 klienst a https://s3.ipfs.ninja címre az API kulcsával mint hitelesítő adattal.

https://s3.ipfs.ninja

S3 művelet	Leírás
PutObject	Fájl feltöltése az IPFS-re
GetObject	Fájl letöltése
HeadObject	Fájl metaadatok lekérése
DeleteObject	Fájl rögzítésének feloldása és törlése
ListObjectsV2	Fájlok listázása prefix szűréssel
CreateMultipartUpload	Multipart feltöltés indítása (legfeljebb 5 GB)
UploadPart	Rész feltöltése
CompleteMultipartUpload	Multipart feltöltés befejezése
ListBuckets	Gateway-ek listázása
CreateBucket	Gateway létrehozása (a bucket nevek globálisan egyediek — BucketAlreadyExists hibát ad, ha foglalt)
DeleteBucket	Gateway törlése
PutBucketCors	Bucketenkénti CORS szabályok konfigurálása (böngészős SDK használatához szükséges)
GetBucketCors	Egy bucket aktuális CORS konfigurációjának lekérése
DeleteBucketCors	Minden CORS szabály eltávolítása egy bucketről

Teljes dokumentációért, kódpéldákért és migrációs útmutatókért lásd az S3 kompatibilitás oldalt.