Referenčná príručka API

Všetky endpointy, parametre, formáty požiadaviek/odpovedí a chybové kódy.

Základná URL

https://api.ipfs.ninja

Všetky požiadavky vyžadujú API kľúč prostredníctvom hlavičky X-Api-Key. Podrobnosti nájdete v časti Autentifikácia.

Endpointy

Metóda	Cesta	Popis	Stránka
POST	/upload/new	Nahranie súboru na IPFS	Súbory
GET	/upload/list	Zoznam nahraných súborov	Súbory
GET	/file/:cid	Získanie metadát súboru podľa CID	Súbory
PUT	/files/:cid/name	Premenovanie súboru	Súbory
PUT	/files/:cid/move	Presunutie súboru do priečinka	Priečinky
POST	/pin	Pripnutie existujúceho CID zo siete IPFS (podporuje swarm-connect tipy)	Pripínanie
GET	/pin/:cid	Kontrola stavu pripnutia	Pripínanie
POST	/folders	Vytvorenie priečinka	Priečinky
GET	/folders	Zoznam priečinkov	Priečinky
PUT	/folders/:folderId	Aktualizácia priečinka	Priečinky
DELETE	/folders/:folderId	Vymazanie priečinka	Priečinky
POST	/folders/:folderId/snapshot	Snímka priečinka do CID adresára	Priečinky
PUT	/folders/:folderId/cors	Nastavenie CORS konfigurácie pre bucket	Priečinky
GET	/folders/:folderId/cors	Získanie CORS konfigurácie pre bucket	Priečinky
DELETE	/folders/:folderId/cors	Odstránenie CORS konfigurácie pre bucket	Priečinky
GET	/user/profile	Získanie profilu používateľa	Profil
POST	/apikeys	Vytvorenie API kľúča	API kľúče
GET	/apikeys	Zoznam API kľúčov	API kľúče
DELETE	/apikeys/:key	Vymazanie API kľúča	API kľúče
GET	/analytics	Analytika využitia	Analytika
PUT	/gateway-settings	Aktualizácia nastavení gateway	Gateway
POST	/gateway-tokens	Vytvorenie tokenu gateway	Gateway
GET	/gateway-tokens	Zoznam tokenov gateway	Gateway
DELETE	/gateway-tokens/:prefix	Vymazanie tokenu gateway	Gateway
POST	/upload/signed-url	Vygenerovanie podpísaného tokenu na nahrávanie	Podpísané tokeny
GET	/signed-tokens	Zoznam podpísaných tokenov	Podpísané tokeny
DELETE	/signed-tokens/:tokenId	Odvolanie podpísaného tokenu	Podpísané tokeny
GET	/image/:cid	Optimalizácia obrázku za behu	Optimalizácia obrázkov

CIDv1 by default

Nahrávania a pripnutia vracajú moderné CIDv1 (bafk… pre malý jednoblokový obsah, bafy… pre väčšie súbory a priečinky) podľa profilu IPIP-0499 unixfs-v1-2025. Staršie CID Qm… z predchádzajúcich nahrávaní zostávajú plne rozpoznateľné všade — Qm… je platný vstup pre každý endpoint, ktorý prijíma CID.

S3-kompatibilné API

Použite ľubovoľný AWS SDK na nahrávanie a správu súborov na IPFS Ninja. Nasmerujte svojho S3 klienta na https://s3.ipfs.ninja s vaším API kľúčom ako prihlasovacími údajmi.

https://s3.ipfs.ninja

Operácia S3	Popis
PutObject	Nahranie súboru na IPFS
GetObject	Stiahnutie súboru
HeadObject	Získanie metadát súboru
DeleteObject	Odpnutie a vymazanie súboru
ListObjectsV2	Zoznam súborov s filtrovaním podľa prefixu
CreateMultipartUpload	Spustenie viacdielneho nahrávania (do 5 GB)
UploadPart	Nahranie časti
CompleteMultipartUpload	Dokončenie viacdielneho nahrávania
ListBuckets	Zoznam vašich gateway
CreateBucket	Vytvorenie gateway (názvy bucketov sú globálne jedinečné — vráti BucketAlreadyExists, ak je názov obsadený)
DeleteBucket	Vymazanie gateway
PutBucketCors	Konfigurácia CORS pravidiel pre bucket (potrebné pre používanie prehliadačového SDK)
GetBucketCors	Prečítanie aktuálnej CORS konfigurácie pre bucket
DeleteBucketCors	Odstránenie všetkých CORS pravidiel z bucketu

Kompletnú dokumentáciu, príklady kódu a sprievodcov migráciou nájdete v časti Kompatibilita s S3.