API 레퍼런스

모든 엔드포인트, 매개변수, 요청/응답 형식, 오류 코드입니다.

기본 URL

https://api.ipfs.ninja

모든 요청에는 X-Api-Key 헤더를 통한 API 키가 필요합니다. 자세한 내용은 인증을 참조하세요.

엔드포인트

메서드	경로	설명	페이지
POST	/upload/new	IPFS에 파일 업로드	파일
GET	/upload/list	업로드된 파일 목록 조회	파일
GET	/file/:cid	CID로 파일 메타데이터 조회	파일
PUT	/files/:cid/name	파일 이름 변경	파일
PUT	/files/:cid/move	파일을 폴더로 이동	폴더
POST	/pin	IPFS 네트워크에서 기존 CID 피닝 (swarm-connect 힌트 지원)	피닝
GET	/pin/:cid	피닝 상태 확인	피닝
POST	/folders	폴더 생성	폴더
GET	/folders	폴더 목록 조회	폴더
PUT	/folders/:folderId	폴더 업데이트	폴더
DELETE	/folders/:folderId	폴더 삭제	폴더
POST	/folders/:folderId/snapshot	폴더를 디렉터리 CID로 스냅샷	폴더
PUT	/folders/:folderId/cors	버킷별 CORS 구성 설정	폴더
GET	/folders/:folderId/cors	버킷별 CORS 구성 조회	폴더
DELETE	/folders/:folderId/cors	버킷별 CORS 구성 제거	폴더
GET	/user/profile	사용자 프로필 조회	프로필
POST	/apikeys	API 키 생성	API 키
GET	/apikeys	API 키 목록 조회	API 키
DELETE	/apikeys/:key	API 키 삭제	API 키
GET	/analytics	사용량 분석	분석
PUT	/gateway-settings	게이트웨이 설정 업데이트	게이트웨이
POST	/gateway-tokens	게이트웨이 토큰 생성	게이트웨이
GET	/gateway-tokens	게이트웨이 토큰 목록 조회	게이트웨이
DELETE	/gateway-tokens/:prefix	게이트웨이 토큰 삭제	게이트웨이
POST	/upload/signed-url	서명된 업로드 토큰 생성	서명된 토큰
GET	/signed-tokens	서명된 토큰 목록 조회	서명된 토큰
DELETE	/signed-tokens/:tokenId	서명된 토큰 폐기	서명된 토큰
GET	/image/:cid	이미지 실시간 최적화	이미지 최적화

기본값은 CIDv1

업로드 및 피닝은 IPIP-0499 unixfs-v1-2025 프로필에 따라 최신 CIDv1(작은 단일 블록 콘텐츠는 bafk…, 더 큰 파일 및 디렉터리는 bafy…)을 반환합니다. 이전 업로드의 레거시 Qm… CID는 어디서든 계속 완전히 해석 가능합니다 — Qm…은 CID를 받는 모든 엔드포인트에 유효한 입력값입니다.

S3 호환 API

모든 AWS SDK를 사용하여 IPFS Ninja에서 파일을 업로드하고 관리하세요. S3 클라이언트를 API 키를 자격 증명으로 사용하여 https://s3.ipfs.ninja로 지정하세요.

https://s3.ipfs.ninja

S3 작업	설명
PutObject	IPFS에 파일 업로드
GetObject	파일 다운로드
HeadObject	파일 메타데이터 조회
DeleteObject	파일 핀 해제 및 삭제
ListObjectsV2	접두사 필터링으로 파일 목록 조회
CreateMultipartUpload	멀티파트 업로드 시작 (최대 5 GB)
UploadPart	파트 업로드
CompleteMultipartUpload	멀티파트 업로드 완료
ListBuckets	게이트웨이 목록 조회
CreateBucket	게이트웨이 생성 (버킷 이름은 전역적으로 고유해야 하며, 이미 사용 중이면 BucketAlreadyExists를 반환)
DeleteBucket	게이트웨이 삭제
PutBucketCors	버킷별 CORS 규칙 구성 (브라우저 SDK 사용 시 필요)
GetBucketCors	버킷의 현재 CORS 구성 조회
DeleteBucketCors	버킷에서 모든 CORS 규칙 제거

전체 문서, 코드 예제, 마이그레이션 가이드는 S3 호환성을 참조하세요.