Довідник API

Усі ендпоінти, параметри, формати запитів/відповідей та коди помилок.

Базовий URL

https://api.ipfs.ninja

Усі запити потребують API key через заголовок X-Api-Key. Див. Автентифікація для деталей.

Ендпоінти

Метод	Шлях	Опис	Сторінка
POST	/upload/new	Завантажити файл в IPFS	Файли
GET	/upload/list	Список завантажених файлів	Файли
GET	/file/:cid	Отримати метадані файлу за CID	Файли
PUT	/files/:cid/name	Перейменувати файл	Файли
PUT	/files/:cid/move	Перемістити файл у папку	Папки
POST	/pin	Закріпити існуючий CID з мережі IPFS (підтримує swarm-connect підказки)	Pinning
GET	/pin/:cid	Перевірити статус закріплення	Pinning
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	Аналітика використання	Analytics
PUT	/gateway-settings	Оновити налаштування gateway	Gateway
POST	/gateway-tokens	Створити токен gateway	Gateway
GET	/gateway-tokens	Список токенів gateway	Gateway
DELETE	/gateway-tokens/:prefix	Видалити токен gateway	Gateway
POST	/upload/signed-url	Згенерувати підписаний токен завантаження	Підписані токени
GET	/signed-tokens	Список підписаних токенів	Підписані токени
DELETE	/signed-tokens/:tokenId	Відкликати підписаний токен	Підписані токени
GET	/image/:cid	Оптимізувати зображення на льоту	Оптимізація зображень

CIDv1 за замовчуванням

Завантаження та закріплення повертають сучасні CIDv1 (bafk… для малого одноблокового контенту, bafy… для більших файлів і директорій) відповідно до профілю IPIP-0499 unixfs-v1-2025. Застарілі CID Qm… з попередніх завантажень залишаються повністю розв'язуваними всюди — Qm… є дійсним входом для будь-якого ендпоінту, що приймає CID.

S3-Compatible API

Використовуйте будь-який AWS SDK для завантаження та керування файлами на IPFS Ninja. Спрямуйте вашого S3-клієнта на https://s3.ipfs.ninja, використовуючи ваш API key як облікові дані.

https://s3.ipfs.ninja

Операція S3	Опис
PutObject	Завантажити файл в IPFS
GetObject	Скачати файл
HeadObject	Отримати метадані файлу
DeleteObject	Відкріпити та видалити файл
ListObjectsV2	Список файлів з фільтрацією за префіксом
CreateMultipartUpload	Розпочати multipart-завантаження (до 5 ГБ)
UploadPart	Завантажити частину
CompleteMultipartUpload	Завершити multipart-завантаження
ListBuckets	Список ваших gateway
CreateBucket	Створити gateway (назви bucket'ів глобально унікальні — повертає BucketAlreadyExists, якщо назва вже зайнята)
DeleteBucket	Видалити gateway
PutBucketCors	Налаштувати правила CORS для окремого bucket'а (необхідно для використання браузерного SDK)
GetBucketCors	Отримати поточну конфігурацію CORS для bucket'а
DeleteBucketCors	Видалити всі правила CORS з bucket'а

Див. S3 Compatibility для повної документації, прикладів коду та посібників з міграції.