Справочник API

Все конечные точки, параметры, форматы запросов/ответов и коды ошибок.

Базовый URL

https://api.ipfs.ninja

Все запросы требуют API-ключ через заголовок 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)	Закрепление
GET	/pin/:cid	Проверить статус закрепления	Закрепление
POST	/folders	Создать папку	Папки
GET	/folders	Список папок	Папки
PUT	/folders/:folderId	Обновить папку	Папки
DELETE	/folders/:folderId	Удалить папку	Папки
POST	/folders/:folderId/snapshot	Сделать снимок папки в виде 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-ключ	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 по умолчанию

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

S3-совместимый API

Используйте любой AWS SDK для загрузки файлов и управления ими на IPFS Ninja. Направьте своего S3-клиента на https://s3.ipfs.ninja, используя свой API-ключ в качестве учётных данных.

https://s3.ipfs.ninja

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

См. Совместимость с S3 для полной документации, примеров кода и руководств по миграции.