Referenční příručka API

Všechny endpointy, parametry, formáty požadavků/odpovědí a chybové kódy.

Základní URL

https://api.ipfs.ninja

Všechny požadavky vyžadují API klíč prostřednictvím hlavičky X-Api-Key. Podrobnosti naleznete v části Autentizace.

Endpointy

Metoda	Cesta	Popis	Stránka
POST	/upload/new	Nahrání souboru na IPFS	Soubory
GET	/upload/list	Seznam nahraných souborů	Soubory
GET	/file/:cid	Získání metadat souboru podle CID	Soubory
PUT	/files/:cid/name	Přejmenování souboru	Soubory
PUT	/files/:cid/move	Přesunutí souboru do složky	Složky
POST	/pin	Připnutí existujícího CID ze sítě IPFS (podporuje nápovědy pro swarm-connect)	Připínání
GET	/pin/:cid	Kontrola stavu připnutí	Připínání
POST	/folders	Vytvoření složky	Složky
GET	/folders	Seznam složek	Složky
PUT	/folders/:folderId	Aktualizace složky	Složky
DELETE	/folders/:folderId	Smazání složky	Složky
POST	/folders/:folderId/snapshot	Snapshot složky do adresářového CID	Složky
PUT	/folders/:folderId/cors	Nastavení CORS konfigurace pro daný bucket	Složky
GET	/folders/:folderId/cors	Získání CORS konfigurace pro daný bucket	Složky
DELETE	/folders/:folderId/cors	Odebrání CORS konfigurace pro daný bucket	Složky
GET	/user/profile	Získání profilu uživatele	Profil
POST	/apikeys	Vytvoření API klíče	API klíče
GET	/apikeys	Seznam API klíčů	API klíče
DELETE	/apikeys/:key	Smazání API klíče	API klíče
GET	/analytics	Analytika využití	Analytika
PUT	/gateway-settings	Aktualizace nastavení gateway	Gateway
POST	/gateway-tokens	Vytvoření tokenu gateway	Gateway
GET	/gateway-tokens	Seznam tokenů gateway	Gateway
DELETE	/gateway-tokens/:prefix	Smazání tokenu gateway	Gateway
POST	/upload/signed-url	Vygenerování podepsaného tokenu pro nahrávání	Podepsané tokeny
GET	/signed-tokens	Seznam podepsaných tokenů	Podepsané tokeny
DELETE	/signed-tokens/:tokenId	Odvolání podepsaného tokenu	Podepsané tokeny
GET	/image/:cid	Optimalizace obrázku za běhu	Optimalizace obrázků

Výchozí formát CIDv1

Nahrání i připnutí vrací moderní CIDv1 (bafk… pro malý jednoblokový obsah, bafy… pro větší soubory a adresáře) podle profilu IPIP-0499 unixfs-v1-2025. Starší CID Qm… z dřívějších nahrání zůstávají všude plně přeložitelné — Qm… je platným vstupem pro každý endpoint, který přijímá CID.

S3-kompatibilní API

Použijte libovolné AWS SDK k nahrávání a správě souborů na IPFS Ninja. Nasměrujte svého S3 klienta na https://s3.ipfs.ninja a jako přihlašovací údaje použijte svůj API klíč.

https://s3.ipfs.ninja

S3 operace	Popis
PutObject	Nahrání souboru na IPFS
GetObject	Stažení souboru
HeadObject	Získání metadat souboru
DeleteObject	Odpojení (unpin) a smazání souboru
ListObjectsV2	Seznam souborů s filtrováním podle prefixu
CreateMultipartUpload	Zahájení multipart uploadu (až 5 GB)
UploadPart	Nahrání části
CompleteMultipartUpload	Dokončení multipart uploadu
ListBuckets	Seznam vašich gateway
CreateBucket	Vytvoření gateway (názvy bucketů jsou globálně jedinečné — vrací BucketAlreadyExists, pokud je název obsazen)
DeleteBucket	Smazání gateway
PutBucketCors	Konfigurace CORS pravidel pro jednotlivý bucket (vyžadováno pro použití v prohlížečovém SDK)
GetBucketCors	Čtení aktuální CORS konfigurace bucketu
DeleteBucketCors	Odebrání všech CORS pravidel z bucketu

Kompletní dokumentaci, příklady kódu a průvodce migrací naleznete v S3 kompatibilitě.