เอกสารอ้างอิง API

Endpoint, พารามิเตอร์, รูปแบบคำขอ/การตอบกลับ และรหัสข้อผิดพลาดทั้งหมด

Base URL

https://api.ipfs.ninja

คำขอทั้งหมดต้องมี API key ผ่านเฮดเดอร์ 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	สแนปช็อตโฟลเดอร์เป็น 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	สร้างโทเค็นอัปโหลดที่ลงนาม	โทเค็นที่ลงนาม
GET	/signed-tokens	แสดงรายการโทเค็นที่ลงนาม	โทเค็นที่ลงนาม
DELETE	/signed-tokens/:tokenId	เพิกถอนโทเค็นที่ลงนาม	โทเค็นที่ลงนาม
GET	/image/:cid	ปรับแต่งรูปภาพแบบ on-the-fly	การปรับแต่งรูปภาพ

CIDv1 เป็นค่าเริ่มต้น

การอัปโหลดและการปักหมุดจะส่งคืน CIDv1 รุ่นใหม่ (bafk… สำหรับเนื้อหาบล็อกเดียวขนาดเล็ก, bafy… สำหรับไฟล์และไดเรกทอรีขนาดใหญ่กว่า) ตามโปรไฟล์ IPIP-0499 unixfs-v1-2025 CID แบบเก่า Qm… จากการอัปโหลดก่อนหน้ายังคงแก้ไข (resolve) ได้อย่างสมบูรณ์ทุกที่ — Qm… เป็นอินพุตที่ถูกต้องสำหรับ endpoint ใดก็ตามที่รับ CID

S3-Compatible API

ใช้ AWS SDK ใดก็ได้เพื่ออัปโหลดและจัดการไฟล์บน IPFS Ninja ชี้ไคลเอนต์ S3 ของคุณไปที่ https://s3.ipfs.ninja โดยใช้ API key ของคุณเป็นข้อมูลประจำตัว

https://s3.ipfs.ninja

S3 Operation	คำอธิบาย
PutObject	อัปโหลดไฟล์ไปยัง IPFS
GetObject	ดาวน์โหลดไฟล์
HeadObject	รับ metadata ของไฟล์
DeleteObject	ถอนปักหมุดและลบไฟล์
ListObjectsV2	แสดงรายการไฟล์พร้อมการกรองด้วย prefix
CreateMultipartUpload	เริ่มการอัปโหลดแบบหลายส่วน (สูงสุด 5 GB)
UploadPart	อัปโหลดส่วนหนึ่ง
CompleteMultipartUpload	เสร็จสิ้นการอัปโหลดแบบหลายส่วน
ListBuckets	แสดงรายการ gateway ของคุณ
CreateBucket	สร้าง gateway (ชื่อ bucket ไม่ซ้ำกันทั่วโลก — ส่งคืน BucketAlreadyExists หากถูกใช้ไปแล้ว)
DeleteBucket	ลบ gateway
PutBucketCors	ตั้งค่ากฎ CORS ต่อ bucket (จำเป็นสำหรับการใช้งาน SDK บนเบราว์เซอร์)
GetBucketCors	อ่านค่า CORS ปัจจุบันของ bucket
DeleteBucketCors	ลบกฎ CORS ทั้งหมดออกจาก bucket

ดู ความเข้ากันได้กับ S3 สำหรับเอกสารฉบับเต็ม ตัวอย่างโค้ด และคำแนะนำการย้ายระบบ