API-reference

Alle endpoints, parametre, forespørgsels-/svarformater og fejlkoder.

Basis-URL

https://api.ipfs.ninja

Alle forespørgsler kræver en API-nøgle via X-Api-Key-headeren. Se Autentificering for detaljer.

Endpoints

Metode	Sti	Beskrivelse	Side
POST	/upload/new	Upload en fil til IPFS	Filer
GET	/upload/list	List uploadede filer	Filer
GET	/file/:cid	Hent filmetadata via CID	Filer
PUT	/files/:cid/name	Omdøb en fil	Filer
PUT	/files/:cid/move	Flyt en fil til en mappe	Mapper
POST	/pin	Fastgør eksisterende CID fra IPFS-netværket (understøtter swarm-connect-hints)	Fastgørelse
GET	/pin/:cid	Tjek fastgørelsesstatus	Fastgørelse
POST	/folders	Opret mappe	Mapper
GET	/folders	List mapper	Mapper
PUT	/folders/:folderId	Opdater mappe	Mapper
DELETE	/folders/:folderId	Slet mappe	Mapper
POST	/folders/:folderId/snapshot	Tag et snapshot af en mappe som et mappe-CID	Mapper
PUT	/folders/:folderId/cors	Angiv CORS-konfiguration per bucket	Mapper
GET	/folders/:folderId/cors	Hent CORS-konfiguration per bucket	Mapper
DELETE	/folders/:folderId/cors	Fjern CORS-konfiguration per bucket	Mapper
GET	/user/profile	Hent brugerprofil	Profil
POST	/apikeys	Opret API-nøgle	API-nøgler
GET	/apikeys	List API-nøgler	API-nøgler
DELETE	/apikeys/:key	Slet API-nøgle	API-nøgler
GET	/analytics	Brugsanalyse	Analyse
PUT	/gateway-settings	Opdater gateway-indstillinger	Gateways
POST	/gateway-tokens	Opret gateway-token	Gateways
GET	/gateway-tokens	List gateway-tokens	Gateways
DELETE	/gateway-tokens/:prefix	Slet gateway-token	Gateways
POST	/upload/signed-url	Generer signeret upload-token	Signerede tokens
GET	/signed-tokens	List signerede tokens	Signerede tokens
DELETE	/signed-tokens/:tokenId	Tilbagekald signeret token	Signerede tokens
GET	/image/:cid	Optimer billede on-the-fly	Billedoptimering

CIDv1 som standard

Uploads og fastgørelser returnerer moderne CIDv1 (bafk… til lille indhold i én blok, bafy… til større filer og mapper) efter IPIP-0499 unixfs-v1-2025-profilen. Ældre Qm…-CID'er fra tidligere uploads forbliver fuldt opløselige overalt — Qm… er gyldigt input til ethvert endpoint, der accepterer et CID.

S3-kompatibelt API

Brug ethvert AWS SDK til at uploade og administrere filer på IPFS Ninja. Peg din S3-klient mod https://s3.ipfs.ninja med din API-nøgle som legitimationsoplysninger.

https://s3.ipfs.ninja

S3-operation	Beskrivelse
PutObject	Upload en fil til IPFS
GetObject	Download en fil
HeadObject	Hent filmetadata
DeleteObject	Fjern fastgørelse og slet en fil
ListObjectsV2	List filer med præfiksfiltrering
CreateMultipartUpload	Start en multipart-upload (op til 5 GB)
UploadPart	Upload en del
CompleteMultipartUpload	Afslut multipart-upload
ListBuckets	List dine gateways
CreateBucket	Opret en gateway (bucket-navne er globalt unikke — returnerer BucketAlreadyExists, hvis navnet er optaget)
DeleteBucket	Slet en gateway
PutBucketCors	Konfigurer CORS-regler per bucket (påkrævet ved brug af browser-SDK)
GetBucketCors	Læs den nuværende CORS-konfiguration for en bucket
DeleteBucketCors	Fjern alle CORS-regler fra en bucket

Se S3-kompatibilitet for fuld dokumentation, kodeeksempler og migreringsguides.