Αναφορά API

Όλα τα endpoints, παράμετροι, μορφές αιτημάτων/απαντήσεων και κωδικοί σφαλμάτων.

Base URL

https://api.ipfs.ninja

Όλα τα αιτήματα απαιτούν API key μέσω του header X-Api-Key. Δείτε Πιστοποίηση για λεπτομέρειες.

Endpoints

Method	Path	Περιγραφή	Σελίδα
POST	/upload/new	Ανέβασμα αρχείου στο IPFS	Αρχεία
GET	/upload/list	Λίστα ανεβασμένων αρχείων	Αρχεία
GET	/file/:cid	Λήψη metadata αρχείου με CID	Αρχεία
PUT	/files/:cid/name	Μετονομασία αρχείου	Αρχεία
PUT	/files/:cid/move	Μετακίνηση αρχείου σε φάκελο	Φάκελοι
POST	/pin	Καρφίτσωμα υπάρχοντος CID από το δίκτυο IPFS (υποστηρίζει υποδείξεις swarm-connect)	Καρφίτσωμα
GET	/pin/:cid	Έλεγχος κατάστασης καρφιτσώματος	Καρφίτσωμα
POST	/folders	Δημιουργία φακέλου	Φάκελοι
GET	/folders	Λίστα φακέλων	Φάκελοι
PUT	/folders/:folderId	Ενημέρωση φακέλου	Φάκελοι
DELETE	/folders/:folderId	Διαγραφή φακέλου	Φάκελοι
POST	/folders/:folderId/snapshot	Στιγμιότυπο (snapshot) φακέλου σε directory CID	Φάκελοι
PUT	/folders/:folderId/cors	Ρύθμιση διαμόρφωσης CORS ανά bucket	Φάκελοι
GET	/folders/:folderId/cors	Λήψη διαμόρφωσης CORS ανά bucket	Φάκελοι
DELETE	/folders/:folderId/cors	Αφαίρεση διαμόρφωσης CORS ανά bucket	Φάκελοι
GET	/user/profile	Λήψη προφίλ χρήστη	Προφίλ
POST	/apikeys	Δημιουργία API key	API Keys
GET	/apikeys	Λίστα API key	API Keys
DELETE	/apikeys/:key	Διαγραφή API key	API Keys
GET	/analytics	Αναλυτικά χρήσης	Αναλυτικά
PUT	/gateway-settings	Ενημέρωση ρυθμίσεων gateway	Gateways
POST	/gateway-tokens	Δημιουργία gateway token	Gateways
GET	/gateway-tokens	Λίστα gateway token	Gateways
DELETE	/gateway-tokens/:prefix	Διαγραφή gateway token	Gateways
POST	/upload/signed-url	Δημιουργία υπογεγραμμένου token ανεβάσματος	Υπογεγραμμένα Token
GET	/signed-tokens	Λίστα υπογεγραμμένων token	Υπογεγραμμένα Token
DELETE	/signed-tokens/:tokenId	Ανάκληση υπογεγραμμένου token	Υπογεγραμμένα Token
GET	/image/:cid	Βελτιστοποίηση εικόνας on-the-fly	Βελτιστοποίηση Εικόνας

CIDv1 από προεπιλογή

Τα ανεβάσματα και τα pins επιστρέφουν σύγχρονα CIDv1 (bafk… για μικρό περιεχόμενο ενός block, bafy… για μεγαλύτερα αρχεία και φακέλους) ακολουθώντας το προφίλ IPIP-0499 unixfs-v1-2025. Τα παλαιότερα CID Qm… από προηγούμενα ανεβάσματα παραμένουν πλήρως επιλύσιμα παντού — το Qm… είναι έγκυρη είσοδος σε οποιοδήποτε endpoint που δέχεται CID.

S3-Compatible API

Χρησιμοποιήστε οποιοδήποτε AWS SDK για να ανεβάσετε και να διαχειριστείτε αρχεία στο IPFS Ninja. Κατευθύνετε τον S3 client σας στο https://s3.ipfs.ninja χρησιμοποιώντας το API key σας ως credentials.

https://s3.ipfs.ninja

Λειτουργία S3	Περιγραφή
PutObject	Ανέβασμα αρχείου στο IPFS
GetObject	Λήψη αρχείου
HeadObject	Λήψη metadata αρχείου
DeleteObject	Αφαίρεση καρφιτσώματος και διαγραφή αρχείου
ListObjectsV2	Λίστα αρχείων με φιλτράρισμα prefix
CreateMultipartUpload	Έναρξη multipart ανεβάσματος (έως 5 GB)
UploadPart	Ανέβασμα ενός part
CompleteMultipartUpload	Ολοκλήρωση multipart ανεβάσματος
ListBuckets	Λίστα των gateways σας
CreateBucket	Δημιουργία gateway (τα ονόματα bucket είναι μοναδικά παγκοσμίως — επιστρέφει BucketAlreadyExists αν είναι κατειλημμένο)
DeleteBucket	Διαγραφή gateway
PutBucketCors	Ρύθμιση κανόνων CORS ανά bucket (απαιτείται για χρήση browser SDK)
GetBucketCors	Ανάγνωση της τρέχουσας ρύθμισης CORS για ένα bucket
DeleteBucketCors	Αφαίρεση όλων των κανόνων CORS από ένα bucket

Δείτε Συμβατότητα S3 για πλήρη τεκμηρίωση, παραδείγματα κώδικα και οδηγούς μετάβασης.