API Referansı

Tüm uç noktalar, parametreler, istek/yanıt formatları ve hata kodları.

Temel URL

https://api.ipfs.ninja

Tüm istekler X-Api-Key başlığı ile bir API anahtarı gerektirir. Ayrıntılar için Kimlik Doğrulama bölümüne bakın.

Uç Noktalar

Yöntem	Yol	Açıklama	Sayfa
POST	/upload/new	IPFS'e dosya yükle	Dosyalar
GET	/upload/list	Yüklenen dosyaları listele	Dosyalar
GET	/file/:cid	CID'ye göre dosya meta verilerini al	Dosyalar
PUT	/files/:cid/name	Bir dosyayı yeniden adlandır	Dosyalar
PUT	/files/:cid/move	Bir dosyayı bir klasöre taşı	Klasörler
POST	/pin	IPFS ağından mevcut CID'yi sabitle (swarm-connect ipuçlarını destekler)	Sabitleme
GET	/pin/:cid	Sabitleme durumunu kontrol et	Sabitleme
POST	/folders	Klasör oluştur	Klasörler
GET	/folders	Klasörleri listele	Klasörler
PUT	/folders/:folderId	Klasörü güncelle	Klasörler
DELETE	/folders/:folderId	Klasörü sil	Klasörler
POST	/folders/:folderId/snapshot	Bir klasörü dizin CID'sine dönüştür (snapshot)	Klasörler
PUT	/folders/:folderId/cors	Bucket başına CORS yapılandırması ayarla	Klasörler
GET	/folders/:folderId/cors	Bucket başına CORS yapılandırmasını al	Klasörler
DELETE	/folders/:folderId/cors	Bucket başına CORS yapılandırmasını kaldır	Klasörler
GET	/user/profile	Kullanıcı profilini al	Profil
POST	/apikeys	API anahtarı oluştur	API Anahtarları
GET	/apikeys	API anahtarlarını listele	API Anahtarları
DELETE	/apikeys/:key	API anahtarını sil	API Anahtarları
GET	/analytics	Kullanım analizleri	Analizler
PUT	/gateway-settings	Gateway ayarlarını güncelle	Gateway'ler
POST	/gateway-tokens	Gateway token'ı oluştur	Gateway'ler
GET	/gateway-tokens	Gateway token'larını listele	Gateway'ler
DELETE	/gateway-tokens/:prefix	Gateway token'ını sil	Gateway'ler
POST	/upload/signed-url	İmzalı yükleme token'ı oluştur	İmzalı Token'lar
GET	/signed-tokens	İmzalı token'ları listele	İmzalı Token'lar
DELETE	/signed-tokens/:tokenId	İmzalı token'ı iptal et	İmzalı Token'lar
GET	/image/:cid	Görüntüyü anında optimize et	Görüntü Optimizasyonu

Varsayılan olarak CIDv1

Yüklemeler ve sabitlemeler, IPIP-0499 unixfs-v1-2025 profiline uygun modern CIDv1 (bafk… küçük tek bloklu içerik için, bafy… daha büyük dosyalar ve dizinler için) döndürür. Önceki yüklemelerden gelen eski Qm… CID'leri her yerde tam olarak çözümlenebilir olmaya devam eder — Qm…, CID kabul eden herhangi bir uç nokta için geçerli bir girdidir.

S3 Uyumlu API

Herhangi bir AWS SDK'sını kullanarak IPFS Ninja üzerinde dosya yükleyin ve yönetin. S3 istemcinizi API anahtarınızı kimlik bilgisi olarak kullanarak https://s3.ipfs.ninja adresine yönlendirin.

https://s3.ipfs.ninja

S3 İşlemi	Açıklama
PutObject	IPFS'e dosya yükle
GetObject	Bir dosyayı indir
HeadObject	Dosya meta verilerini al
DeleteObject	Bir dosyanın sabitlemesini kaldır ve sil
ListObjectsV2	Ön ek filtrelemesiyle dosyaları listele
CreateMultipartUpload	Bir multipart yüklemeyi başlat (5 GB'a kadar)
UploadPart	Bir parça yükle
CompleteMultipartUpload	Multipart yüklemeyi tamamla
ListBuckets	Gateway'lerinizi listele
CreateBucket	Bir gateway oluştur (bucket adları global olarak benzersizdir — alınmışsa BucketAlreadyExists döner)
DeleteBucket	Bir gateway'i sil
PutBucketCors	Bucket başına CORS kurallarını yapılandır (tarayıcı SDK kullanımı için gereklidir)
GetBucketCors	Bir bucket için mevcut CORS yapılandırmasını oku
DeleteBucketCors	Bir bucket'tan tüm CORS kurallarını kaldır

Tam dokümantasyon, kod örnekleri ve geçiş kılavuzları için S3 Uyumluluğu bölümüne bakın.