Referenca API-ja

Svi endpointovi, parametri, formati zahtjeva/odgovora i kodovi grešaka.

Osnovni URL

https://api.ipfs.ninja

Svi zahtjevi zahtijevaju API ključ putem zaglavlja X-Api-Key. Pogledajte Autentifikacija za detalje.

Endpointovi

Metoda	Putanja	Opis	Stranica
POST	/upload/new	Prijenos datoteke na IPFS	Datoteke
GET	/upload/list	Popis prenesenih datoteka	Datoteke
GET	/file/:cid	Dohvat metapodataka datoteke po CID-u	Datoteke
PUT	/files/:cid/name	Preimenovanje datoteke	Datoteke
PUT	/files/:cid/move	Premještanje datoteke u mapu	Mape
POST	/pin	Prikvačivanje postojećeg CID-a s IPFS mreže (podržava naznake za swarm-connect)	Prikvačivanje
GET	/pin/:cid	Provjera statusa prikvačivanja	Prikvačivanje
POST	/folders	Kreiranje mape	Mape
GET	/folders	Popis mapa	Mape
PUT	/folders/:folderId	Ažuriranje mape	Mape
DELETE	/folders/:folderId	Brisanje mape	Mape
POST	/folders/:folderId/snapshot	Snimanje mape u CID direktorija	Mape
PUT	/folders/:folderId/cors	Postavljanje CORS konfiguracije po bucketu	Mape
GET	/folders/:folderId/cors	Dohvat CORS konfiguracije po bucketu	Mape
DELETE	/folders/:folderId/cors	Uklanjanje CORS konfiguracije po bucketu	Mape
GET	/user/profile	Dohvat korisničkog profila	Profil
POST	/apikeys	Kreiranje API ključa	API ključevi
GET	/apikeys	Popis API ključeva	API ključevi
DELETE	/apikeys/:key	Brisanje API ključa	API ključevi
GET	/analytics	Analitika korištenja	Analitika
PUT	/gateway-settings	Ažuriranje postavki gatewaya	Gatewayevi
POST	/gateway-tokens	Kreiranje tokena gatewaya	Gatewayevi
GET	/gateway-tokens	Popis tokena gatewaya	Gatewayevi
DELETE	/gateway-tokens/:prefix	Brisanje tokena gatewaya	Gatewayevi
POST	/upload/signed-url	Generiranje potpisanog tokena za prijenos	Potpisani tokeni
GET	/signed-tokens	Popis potpisanih tokena	Potpisani tokeni
DELETE	/signed-tokens/:tokenId	Opoziv potpisanog tokena	Potpisani tokeni
GET	/image/:cid	Optimizacija slike u hodu	Optimizacija slika

CIDv1 prema zadanim postavkama

Prijenosi i prikvačivanja vraćaju moderne CIDv1 (bafk… za manji sadržaj u jednom bloku, bafy… za veće datoteke i mape) prema profilu IPIP-0499 unixfs-v1-2025. Stariji Qm… CID-ovi iz ranijih prijenosa ostaju u potpunosti razrješivi posvuda — Qm… je važeći unos za bilo koji endpoint koji prihvaća CID.

S3-kompatibilni API

Koristite bilo koji AWS SDK za prijenos i upravljanje datotekama na IPFS Ninja. Usmjerite svog S3 klijenta na https://s3.ipfs.ninja s vašim API ključem kao vjerodajnicama.

https://s3.ipfs.ninja

S3 operacija	Opis
PutObject	Prijenos datoteke na IPFS
GetObject	Preuzimanje datoteke
HeadObject	Dohvat metapodataka datoteke
DeleteObject	Uklanjanje prikvačivanja i brisanje datoteke
ListObjectsV2	Popis datoteka s filtriranjem po prefiksu
CreateMultipartUpload	Pokretanje multipart prijenosa (do 5 GB)
UploadPart	Prijenos dijela
CompleteMultipartUpload	Završetak multipart prijenosa
ListBuckets	Popis vaših gatewayeva
CreateBucket	Kreiranje gatewaya (nazivi bucketa su globalno jedinstveni — vraća BucketAlreadyExists ako je naziv zauzet)
DeleteBucket	Brisanje gatewaya
PutBucketCors	Konfiguracija CORS pravila po bucketu (potrebno za korištenje browser SDK-a)
GetBucketCors	Čitanje trenutne CORS konfiguracije za bucket
DeleteBucketCors	Uklanjanje svih CORS pravila iz bucketa

Pogledajte S3 kompatibilnost za punu dokumentaciju, primjere koda i vodiče za migraciju.