API Reference

Lahat ng endpoint, parameter, format ng request/response, at error code.

Base URL

https://api.ipfs.ninja

Ang lahat ng request ay nangangailangan ng API key sa pamamagitan ng X-Api-Key header. Tingnan ang Authentication para sa mga detalye.

Mga Endpoint

Method	Path	Paglalarawan	Pahina
POST	/upload/new	Mag-upload ng file sa IPFS	Mga File
GET	/upload/list	Ilista ang mga na-upload na file	Mga File
GET	/file/:cid	Kunin ang file metadata gamit ang CID	Mga File
PUT	/files/:cid/name	Palitan ang pangalan ng file	Mga File
PUT	/files/:cid/move	Ilipat ang file sa isang folder	Mga Folder
POST	/pin	I-pin ang umiiral na CID mula sa IPFS network (sinusuportahan ang swarm-connect hints)	Pinning
GET	/pin/:cid	Suriin ang pin status	Pinning
POST	/folders	Gumawa ng folder	Mga Folder
GET	/folders	Ilista ang mga folder	Mga Folder
PUT	/folders/:folderId	I-update ang folder	Mga Folder
DELETE	/folders/:folderId	Burahin ang folder	Mga Folder
POST	/folders/:folderId/snapshot	I-snapshot ang folder sa isang directory CID	Mga Folder
PUT	/folders/:folderId/cors	Itakda ang per-bucket CORS config	Mga Folder
GET	/folders/:folderId/cors	Kunin ang per-bucket CORS config	Mga Folder
DELETE	/folders/:folderId/cors	Alisin ang per-bucket CORS config	Mga Folder
GET	/user/profile	Kunin ang user profile	Profile
POST	/apikeys	Gumawa ng API key	API Keys
GET	/apikeys	Ilista ang mga API key	API Keys
DELETE	/apikeys/:key	Tanggalin ang API key	API Keys
GET	/analytics	Mga usage analytics	Analytics
PUT	/gateway-settings	I-update ang gateway settings	Gateways
POST	/gateway-tokens	Gumawa ng gateway token	Gateways
GET	/gateway-tokens	Ilista ang mga gateway token	Gateways
DELETE	/gateway-tokens/:prefix	Tanggalin ang gateway token	Gateways
POST	/upload/signed-url	Bumuo ng signed upload token	Signed Tokens
GET	/signed-tokens	Ilista ang mga signed token	Signed Tokens
DELETE	/signed-tokens/:tokenId	I-revoke ang signed token	Signed Tokens
GET	/image/:cid	I-optimize ang imahe on-the-fly	Image Optimization

CIDv1 bilang default

Ang mga upload at pin ay nagbabalik ng modernong CIDv1 (bafk… para sa maliit na single-block na nilalaman, bafy… para sa mas malalaking file at directory) na sumusunod sa IPIP-0499 unixfs-v1-2025 profile. Ang legacy Qm… na mga CID mula sa mga naunang upload ay nananatiling ganap na resolvable saanman — ang Qm… ay valid na input sa anumang endpoint na tumatanggap ng CID.

S3-Compatible API

Gamitin ang anumang AWS SDK para mag-upload at mamahala ng mga file sa IPFS Ninja. Ituro ang iyong S3 client sa https://s3.ipfs.ninja gamit ang iyong API key bilang mga kredensyal.

https://s3.ipfs.ninja

S3 Operation	Paglalarawan
PutObject	Mag-upload ng file sa IPFS
GetObject	Mag-download ng file
HeadObject	Kunin ang file metadata
DeleteObject	I-unpin at burahin ang file
ListObjectsV2	Ilista ang mga file na may prefix filtering
CreateMultipartUpload	Simulan ang multipart upload (hanggang 5 GB)
UploadPart	Mag-upload ng bahagi
CompleteMultipartUpload	Tapusin ang multipart upload
ListBuckets	Ilista ang iyong mga gateway
CreateBucket	Gumawa ng gateway (ang mga pangalan ng bucket ay globally unique — nagbabalik ng BucketAlreadyExists kung nakuha na)
DeleteBucket	Burahin ang gateway
PutBucketCors	I-configure ang per-bucket CORS rules (kinakailangan para sa paggamit ng browser SDK)
GetBucketCors	Basahin ang kasalukuyang CORS config para sa isang bucket
DeleteBucketCors	Alisin ang lahat ng CORS rules mula sa isang bucket

Tingnan ang S3 Compatibility para sa buong dokumentasyon, mga code example, at migration guides.