API-referanse

Alle endepunkter, parametere, forespørsels-/svarsformater og feilkoder.

Basis-URL

https://api.ipfs.ninja

Alle forespørsler krever en API-nøkkel via X-Api-Key-headeren. Se Autentisering for detaljer.

Endepunkter

Metode	Sti	Beskrivelse	Side
POST	/upload/new	Last opp en fil til IPFS	Filer
GET	/upload/list	List opplastede filer	Filer
GET	/file/:cid	Hent filmetadata via CID	Filer
PUT	/files/:cid/name	Gi en fil nytt navn	Filer
PUT	/files/:cid/move	Flytt en fil til en mappe	Mapper
POST	/pin	Fest eksisterende CID fra IPFS-nettverket (støtter swarm-connect-hint)	Festing
GET	/pin/:cid	Sjekk festingsstatus	Festing
POST	/folders	Opprett mappe	Mapper
GET	/folders	List mapper	Mapper
PUT	/folders/:folderId	Oppdater mappe	Mapper
DELETE	/folders/:folderId	Slett mappe	Mapper
POST	/folders/:folderId/snapshot	Ta et øyeblikksbilde av en mappe som en katalog-CID	Mapper
PUT	/folders/:folderId/cors	Sett CORS-konfigurasjon per bucket	Mapper
GET	/folders/:folderId/cors	Hent CORS-konfigurasjon per bucket	Mapper
DELETE	/folders/:folderId/cors	Fjern CORS-konfigurasjon per bucket	Mapper
GET	/user/profile	Hent brukerprofil	Profil
POST	/apikeys	Opprett API-nøkkel	API-nøkler
GET	/apikeys	List API-nøkler	API-nøkler
DELETE	/apikeys/:key	Slett API-nøkkel	API-nøkler
GET	/analytics	Bruksanalyse	Analyse
PUT	/gateway-settings	Oppdater gateway-innstillinger	Gateways
POST	/gateway-tokens	Opprett gateway-token	Gateways
GET	/gateway-tokens	List gateway-tokener	Gateways
DELETE	/gateway-tokens/:prefix	Slett gateway-token	Gateways
POST	/upload/signed-url	Generer signert opplastingstoken	Signerte tokener
GET	/signed-tokens	List signerte tokener	Signerte tokener
DELETE	/signed-tokens/:tokenId	Tilbakekall signert token	Signerte tokener
GET	/image/:cid	Optimaliser bilde direkte	Bildeoptimalisering

CIDv1 som standard

Opplastinger og festinger returnerer moderne CIDv1 (bafk… for lite innhold i én blokk, bafy… for større filer og kataloger) i tråd med IPIP-0499 unixfs-v1-2025-profilen. Eldre Qm…-CID-er fra tidligere opplastinger forblir fullt oppløselige overalt — Qm… er en gyldig inndata til ethvert endepunkt som godtar en CID.

S3-kompatibelt API

Bruk hvilken som helst AWS SDK til å laste opp og administrere filer på IPFS Ninja. Pek S3-klienten din mot https://s3.ipfs.ninja med API-nøkkelen din som legitimasjon.

https://s3.ipfs.ninja

S3-operasjon	Beskrivelse
PutObject	Last opp en fil til IPFS
GetObject	Last ned en fil
HeadObject	Hent filmetadata
DeleteObject	Avpinn og slett en fil
ListObjectsV2	List filer med prefiksfiltrering
CreateMultipartUpload	Start en flerdelt opplasting (opptil 5 GB)
UploadPart	Last opp en del
CompleteMultipartUpload	Fullfør flerdelt opplasting
ListBuckets	List gatewayene dine
CreateBucket	Opprett en gateway (bucket-navn er globalt unike — returnerer BucketAlreadyExists hvis navnet er opptatt)
DeleteBucket	Slett en gateway
PutBucketCors	Konfigurer CORS-regler per bucket (påkrevd for bruk av nettleser-SDK-er)
GetBucketCors	Les gjeldende CORS-konfigurasjon for en bucket
DeleteBucketCors	Fjern alle CORS-regler fra en bucket

Se S3-kompatibilitet for full dokumentasjon, kodeeksempler og migreringsguider.