API-Referenz

Alle Endpunkte, Parameter, Anfrage-/Antwortformate und Fehlercodes.

Basis-URL

https://api.ipfs.ninja

Alle Anfragen erfordern einen API-Schlüssel über den X-Api-Key-Header. Siehe Authentifizierung für Details.

Endpunkte

Methode	Pfad	Beschreibung	Seite
POST	/upload/new	Datei auf IPFS hochladen	Dateien
GET	/upload/list	Hochgeladene Dateien auflisten	Dateien
GET	/file/:cid	Datei-Metadaten nach CID abrufen	Dateien
PUT	/files/:cid/name	Datei umbenennen	Dateien
PUT	/files/:cid/move	Datei in einen Ordner verschieben	Ordner
POST	/pin	Bestehenden CID aus dem IPFS-Netzwerk pinnen (unterstützt Swarm-Connect-Hinweise)	Pinning
GET	/pin/:cid	Pin-Status prüfen	Pinning
POST	/folders	Ordner erstellen	Ordner
GET	/folders	Ordner auflisten	Ordner
PUT	/folders/:folderId	Ordner aktualisieren	Ordner
DELETE	/folders/:folderId	Ordner löschen	Ordner
POST	/folders/:folderId/snapshot	Ordner als Verzeichnis-CID snapshotten	Ordner
PUT	/folders/:folderId/cors	CORS-Konfiguration pro Bucket festlegen	Ordner
GET	/folders/:folderId/cors	CORS-Konfiguration pro Bucket abrufen	Ordner
DELETE	/folders/:folderId/cors	CORS-Konfiguration pro Bucket entfernen	Ordner
GET	/user/profile	Benutzerprofil abrufen	Profil
POST	/apikeys	API-Schlüssel erstellen	API-Schlüssel
GET	/apikeys	API-Schlüssel auflisten	API-Schlüssel
DELETE	/apikeys/:key	API-Schlüssel löschen	API-Schlüssel
GET	/analytics	Nutzungsanalysen	Analysen
PUT	/gateway-settings	Gateway-Einstellungen aktualisieren	Gateways
POST	/gateway-tokens	Gateway-Token erstellen	Gateways
GET	/gateway-tokens	Gateway-Token auflisten	Gateways
DELETE	/gateway-tokens/:prefix	Gateway-Token löschen	Gateways
POST	/upload/signed-url	Signierten Upload-Token generieren	Signierte Token
GET	/signed-tokens	Signierte Token auflisten	Signierte Token
DELETE	/signed-tokens/:tokenId	Signierten Token widerrufen	Signierte Token
GET	/image/:cid	Bild on-the-fly optimieren	Bildoptimierung

CIDv1 standardmäßig

Uploads und Pins geben moderne CIDv1 zurück (bafk… für kleine Einzelblock-Inhalte, bafy… für größere Dateien und Verzeichnisse) gemäß dem IPIP-0499 unixfs-v1-2025-Profil. Ältere Qm…-CIDs aus früheren Uploads bleiben überall vollständig auflösbar — Qm… ist als Eingabe für jeden Endpunkt gültig, der einen CID akzeptiert.

S3-kompatible API

Verwenden Sie ein beliebiges AWS SDK, um Dateien auf IPFS Ninja hochzuladen und zu verwalten. Richten Sie Ihren S3-Client mit Ihrem API-Schlüssel als Zugangsdaten auf https://s3.ipfs.ninja aus.

https://s3.ipfs.ninja

S3-Operation	Beschreibung
PutObject	Datei auf IPFS hochladen
GetObject	Datei herunterladen
HeadObject	Datei-Metadaten abrufen
DeleteObject	Pinning einer Datei entfernen und löschen
ListObjectsV2	Dateien mit Präfix-Filterung auflisten
CreateMultipartUpload	Multipart-Upload starten (bis zu 5 GB)
UploadPart	Teil hochladen
CompleteMultipartUpload	Multipart-Upload abschließen
ListBuckets	Ihre Gateways auflisten
CreateBucket	Gateway erstellen (Bucket-Namen sind global eindeutig — gibt BucketAlreadyExists zurück, falls bereits vergeben)
DeleteBucket	Gateway löschen
PutBucketCors	CORS-Regeln pro Bucket konfigurieren (erforderlich für Browser-SDK-Nutzung)
GetBucketCors	Aktuelle CORS-Konfiguration eines Buckets auslesen
DeleteBucketCors	Alle CORS-Regeln eines Buckets entfernen

Vollständige Dokumentation, Code-Beispiele und Migrationsleitfäden finden Sie unter S3-Kompatibilität.