API-referentie

Alle endpoints, parameters, verzoek/antwoord-formaten en foutcodes.

Basis-URL

https://api.ipfs.ninja

Alle verzoeken vereisen een API-sleutel via de X-Api-Key-header. Zie Authenticatie voor details.

Endpoints

Methode	Pad	Beschrijving	Pagina
POST	/upload/new	Upload een bestand naar IPFS	Bestanden
GET	/upload/list	Lijst geüploade bestanden op	Bestanden
GET	/file/:cid	Haal bestandsmetadata op via CID	Bestanden
PUT	/files/:cid/name	Hernoem een bestand	Bestanden
PUT	/files/:cid/move	Verplaats een bestand naar een map	Mappen
POST	/pin	Zet een bestaande CID vast vanuit het IPFS-netwerk (ondersteunt swarm-connect-hints)	Vastzetten
GET	/pin/:cid	Controleer vastzetstatus	Vastzetten
POST	/folders	Maak een map aan	Mappen
GET	/folders	Lijst mappen op	Mappen
PUT	/folders/:folderId	Werk een map bij	Mappen
DELETE	/folders/:folderId	Verwijder een map	Mappen
POST	/folders/:folderId/snapshot	Maak een snapshot van een map als directory-CID	Mappen
PUT	/folders/:folderId/cors	Stel per-bucket CORS-configuratie in	Mappen
GET	/folders/:folderId/cors	Haal per-bucket CORS-configuratie op	Mappen
DELETE	/folders/:folderId/cors	Verwijder per-bucket CORS-configuratie	Mappen
GET	/user/profile	Haal gebruikersprofiel op	Profiel
POST	/apikeys	Maak een API-sleutel aan	API-sleutels
GET	/apikeys	Lijst API-sleutels op	API-sleutels
DELETE	/apikeys/:key	Verwijder een API-sleutel	API-sleutels
GET	/analytics	Gebruiksanalyse	Analyse
PUT	/gateway-settings	Werk gateway-instellingen bij	Gateways
POST	/gateway-tokens	Maak een gateway-token aan	Gateways
GET	/gateway-tokens	Lijst gateway-tokens op	Gateways
DELETE	/gateway-tokens/:prefix	Verwijder een gateway-token	Gateways
POST	/upload/signed-url	Genereer een ondertekend upload-token	Ondertekende tokens
GET	/signed-tokens	Lijst ondertekende tokens op	Ondertekende tokens
DELETE	/signed-tokens/:tokenId	Trek een ondertekend token in	Ondertekende tokens
GET	/image/:cid	Optimaliseer een afbeelding direct	Beeldoptimalisatie

CIDv1 standaard

Uploads en vastzetacties retourneren moderne CIDv1 (bafk… voor kleine content in één blok, bafy… voor grotere bestanden en directory's) volgens het IPIP-0499 unixfs-v1-2025-profiel. Legacy Qm…-CID's van eerdere uploads blijven overal volledig oplosbaar — Qm… is een geldige invoer voor elk endpoint dat een CID accepteert.

S3-compatibele API

Gebruik elke AWS SDK om bestanden te uploaden en beheren op IPFS Ninja. Richt je S3-client op https://s3.ipfs.ninja met je API-sleutel als credentials.

https://s3.ipfs.ninja

S3-operatie	Beschrijving
PutObject	Upload een bestand naar IPFS
GetObject	Download een bestand
HeadObject	Haal bestandsmetadata op
DeleteObject	Zet een bestand los en verwijder het
ListObjectsV2	Lijst bestanden op met prefixfiltering
CreateMultipartUpload	Start een multipart-upload (tot 5 GB)
UploadPart	Upload een deel
CompleteMultipartUpload	Voltooi de multipart-upload
ListBuckets	Lijst je gateways op
CreateBucket	Maak een gateway aan (bucketnamen zijn wereldwijd uniek — geeft BucketAlreadyExists terug als de naam al in gebruik is)
DeleteBucket	Verwijder een gateway
PutBucketCors	Configureer per-bucket CORS-regels (vereist voor gebruik met browser-SDK's)
GetBucketCors	Lees de huidige CORS-configuratie van een bucket
DeleteBucketCors	Verwijder alle CORS-regels van een bucket

Zie S3-compatibiliteit voor volledige documentatie, codevoorbeelden en migratiegidsen.