Dokumentacja API

Wszystkie endpointy, parametry, formaty żądań/odpowiedzi i kody błędów.

Bazowy URL

https://api.ipfs.ninja

Wszystkie żądania wymagają klucza API przez nagłówek X-Api-Key. Zobacz Autentykacja po szczegóły.

Endpointy

Metoda	Ścieżka	Opis	Strona
POST	/upload/new	Prześlij plik do IPFS	Pliki
GET	/upload/list	Lista przesłanych plików	Pliki
GET	/file/:cid	Pobierz metadane pliku po CID	Pliki
PUT	/files/:cid/name	Zmień nazwę pliku	Pliki
PUT	/files/:cid/move	Przenieś plik do folderu	Foldery
POST	/pin	Przypnij istniejący CID z sieci IPFS (obsługuje wskazówki swarm-connect)	Przypinanie
GET	/pin/:cid	Sprawdź status przypięcia	Przypinanie
POST	/folders	Utwórz folder	Foldery
GET	/folders	Lista folderów	Foldery
PUT	/folders/:folderId	Zaktualizuj folder	Foldery
DELETE	/folders/:folderId	Usuń folder	Foldery
POST	/folders/:folderId/snapshot	Zrób migawkę folderu jako CID katalogu	Foldery
PUT	/folders/:folderId/cors	Ustaw konfigurację CORS dla bucketa	Foldery
GET	/folders/:folderId/cors	Pobierz konfigurację CORS dla bucketa	Foldery
DELETE	/folders/:folderId/cors	Usuń konfigurację CORS dla bucketa	Foldery
GET	/user/profile	Pobierz profil użytkownika	Profil
POST	/apikeys	Utwórz klucz API	Klucze API
GET	/apikeys	Lista kluczy API	Klucze API
DELETE	/apikeys/:key	Usuń klucz API	Klucze API
GET	/analytics	Analityka użycia	Analityka
PUT	/gateway-settings	Aktualizuj ustawienia bramki	Bramki
POST	/gateway-tokens	Utwórz token bramki	Bramki
GET	/gateway-tokens	Lista tokenów bramki	Bramki
DELETE	/gateway-tokens/:prefix	Usuń token bramki	Bramki
POST	/upload/signed-url	Wygeneruj podpisany token przesyłania	Podpisane tokeny
GET	/signed-tokens	Lista podpisanych tokenów	Podpisane tokeny
DELETE	/signed-tokens/:tokenId	Odwołaj podpisany token	Podpisane tokeny
GET	/image/:cid	Optymalizuj obraz w locie	Optymalizacja obrazów

CIDv1 domyślnie

Przesłania i przypięcia zwracają nowoczesne CIDv1 (bafk… dla małej, jednoblokowej treści, bafy… dla większych plików i katalogów) zgodnie z profilem IPIP-0499 unixfs-v1-2025. Starsze CID-y Qm… z wcześniejszych przesłań pozostają w pełni rozwiązywalne wszędzie — Qm… jest prawidłowym wejściem dla każdego endpointu przyjmującego CID.

API zgodne z S3

Użyj dowolnego AWS SDK do przesyłania i zarządzania plikami na IPFS Ninja. Skieruj swojego klienta S3 na https://s3.ipfs.ninja, używając klucza API jako danych uwierzytelniających.

https://s3.ipfs.ninja

Operacja S3	Opis
PutObject	Prześlij plik do IPFS
GetObject	Pobierz plik
HeadObject	Pobierz metadane pliku
DeleteObject	Odepnij i usuń plik
ListObjectsV2	Lista plików z filtrowaniem po prefiksie
CreateMultipartUpload	Rozpocznij przesyłanie wieloczęściowe (do 5 GB)
UploadPart	Prześlij część
CompleteMultipartUpload	Zakończ przesyłanie wieloczęściowe
ListBuckets	Lista twoich bramek
CreateBucket	Utwórz bramkę (nazwy bucketów są globalnie unikalne — zwraca BucketAlreadyExists, jeśli zajęta)
DeleteBucket	Usuń bramkę
PutBucketCors	Skonfiguruj reguły CORS per bucket (wymagane do użycia SDK w przeglądarce)
GetBucketCors	Odczytaj bieżącą konfigurację CORS bucketa
DeleteBucketCors	Usuń wszystkie reguły CORS z bucketa

Zobacz Kompatybilność z S3 po pełną dokumentację, przykłady kodu i przewodniki migracji.