API atsauce

Visi galapunkti, parametri, pieprasījumu/atbilžu formāti un kļūdu kodi.

Bāzes URL

https://api.ipfs.ninja

Visiem pieprasījumiem nepieciešama API atslēga caur X-Api-Key galveni. Skatiet Autentifikācija detaļām.

Galapunkti

Metode	Ceļš	Apraksts	Lapa
POST	/upload/new	Augšupielādēt failu IPFS	Faili
GET	/upload/list	Uzskaitīt augšupielādētos failus	Faili
GET	/file/:cid	Iegūt faila metadatus pēc CID	Faili
PUT	/files/:cid/name	Pārdēvēt failu	Faili
PUT	/files/:cid/move	Pārvietot failu uz mapi	Mapes
POST	/pin	Piespraust esošu CID no IPFS tīkla (atbalsta swarm-connect norādes)	Piespraušana
GET	/pin/:cid	Pārbaudīt piespraušanas statusu	Piespraušana
POST	/folders	Izveidot mapi	Mapes
GET	/folders	Uzskaitīt mapes	Mapes
PUT	/folders/:folderId	Atjaunināt mapi	Mapes
DELETE	/folders/:folderId	Dzēst mapi	Mapes
POST	/folders/:folderId/snapshot	Uzņemt mapes momentuzņēmumu kā direktorijas CID	Mapes
PUT	/folders/:folderId/cors	Iestatīt CORS konfigurāciju katram bucket	Mapes
GET	/folders/:folderId/cors	Iegūt CORS konfigurāciju katram bucket	Mapes
DELETE	/folders/:folderId/cors	Noņemt CORS konfigurāciju katram bucket	Mapes
GET	/user/profile	Iegūt lietotāja profilu	Profils
POST	/apikeys	Izveidot API atslēgu	API atslēgas
GET	/apikeys	Uzskaitīt API atslēgas	API atslēgas
DELETE	/apikeys/:key	Dzēst API atslēgu	API atslēgas
GET	/analytics	Lietošanas analītika	Analītika
PUT	/gateway-settings	Atjaunināt gateway iestatījumus	Gateway
POST	/gateway-tokens	Izveidot gateway tokenu	Gateway
GET	/gateway-tokens	Uzskaitīt gateway tokenus	Gateway
DELETE	/gateway-tokens/:prefix	Dzēst gateway tokenu	Gateway
POST	/upload/signed-url	Ģenerēt parakstītu augšupielādes tokenu	Parakstīti tokeni
GET	/signed-tokens	Uzskaitīt parakstītus tokenus	Parakstīti tokeni
DELETE	/signed-tokens/:tokenId	Atsaukt parakstītu tokenu	Parakstīti tokeni
GET	/image/:cid	Optimizēt attēlu lidojumā	Attēlu optimizācija

CIDv1 pēc noklusējuma

Augšupielādes un piespraušanas atgriež modernus CIDv1 (bafk… mazam, viena bloka saturam, bafy… lielākiem failiem un direktorijām) saskaņā ar IPIP-0499 unixfs-v1-2025 profilu. Vecmodīgie Qm… CID no iepriekšējām augšupielādēm joprojām pilnībā atrisinās visur — Qm… ir derīga ievade jebkuram galapunktam, kas pieņem CID.

S3 saderīgais API

Izmantojiet jebkuru AWS SDK, lai augšupielādētu un pārvaldītu failus IPFS Ninja platformā. Norādiet savu S3 klientu uz https://s3.ipfs.ninja ar savu API atslēgu kā akreditācijas datiem.

https://s3.ipfs.ninja

S3 operācija	Apraksts
PutObject	Augšupielādēt failu IPFS
GetObject	Lejupielādēt failu
HeadObject	Iegūt faila metadatus
DeleteObject	Atspraust un dzēst failu
ListObjectsV2	Uzskaitīt failus ar prefiksa filtrēšanu
CreateMultipartUpload	Sākt vairākdaļu augšupielādi (līdz 5 GB)
UploadPart	Augšupielādēt daļu
CompleteMultipartUpload	Pabeigt vairākdaļu augšupielādi
ListBuckets	Uzskaitīt savus gateway
CreateBucket	Izveidot gateway (bucket nosaukumi ir globāli unikāli — atgriež BucketAlreadyExists, ja tas jau ir aizņemts)
DeleteBucket	Dzēst gateway
PutBucketCors	Konfigurēt CORS noteikumus katram bucket (nepieciešams pārlūka SDK izmantošanai)
GetBucketCors	Nolasīt pašreizējo CORS konfigurāciju bucket
DeleteBucketCors	Noņemt visus CORS noteikumus no bucket

Skatiet S3 saderība pilnai dokumentācijai, koda piemēriem un migrācijas rokasgrāmatām.