Referencia de la API

Todos los endpoints, parámetros, formatos de solicitud/respuesta y códigos de error.

URL Base

https://api.ipfs.ninja

Todas las solicitudes requieren una clave API a través del encabezado X-Api-Key. Consulta Autenticación para más detalles.

Endpoints

Método	Ruta	Descripción	Página
POST	/upload/new	Subir un archivo a IPFS	Archivos
GET	/upload/list	Listar archivos subidos	Archivos
GET	/file/:cid	Obtener metadatos de archivo por CID	Archivos
PUT	/files/:cid/name	Renombrar un archivo	Archivos
PUT	/files/:cid/move	Mover un archivo a una carpeta	Carpetas
POST	/pin	Fijar un CID existente de la red IPFS (admite indicaciones swarm-connect)	Fijación
GET	/pin/:cid	Verificar estado de fijación	Fijación
POST	/folders	Crear carpeta	Carpetas
GET	/folders	Listar carpetas	Carpetas
PUT	/folders/:folderId	Actualizar carpeta	Carpetas
DELETE	/folders/:folderId	Eliminar carpeta	Carpetas
POST	/folders/:folderId/snapshot	Crear snapshot de una carpeta como CID de directorio	Carpetas
PUT	/folders/:folderId/cors	Configurar CORS por bucket	Carpetas
GET	/folders/:folderId/cors	Obtener configuración CORS por bucket	Carpetas
DELETE	/folders/:folderId/cors	Eliminar configuración CORS por bucket	Carpetas
GET	/user/profile	Obtener perfil de usuario	Perfil
POST	/apikeys	Crear clave API	Claves API
GET	/apikeys	Listar claves API	Claves API
DELETE	/apikeys/:key	Eliminar clave API	Claves API
GET	/analytics	Analíticas de uso	Analíticas
PUT	/gateway-settings	Actualizar configuración del gateway	Gateways
POST	/gateway-tokens	Crear token de gateway	Gateways
GET	/gateway-tokens	Listar tokens de gateway	Gateways
DELETE	/gateway-tokens/:prefix	Eliminar token de gateway	Gateways
POST	/upload/signed-url	Generar token de subida firmado	Tokens Firmados
GET	/signed-tokens	Listar tokens firmados	Tokens Firmados
DELETE	/signed-tokens/:tokenId	Revocar token firmado	Tokens Firmados
GET	/image/:cid	Optimizar imagen al vuelo	Optimización de Imágenes

CIDv1 por defecto

Las subidas y fijaciones devuelven CIDv1 moderno (bafk… para contenido pequeño de un solo bloque, bafy… para archivos y directorios más grandes) siguiendo el perfil IPIP-0499 unixfs-v1-2025. Los CIDs Qm… heredados de subidas anteriores siguen siendo totalmente resolubles en todas partes — Qm… es una entrada válida para cualquier endpoint que acepte un CID.

API compatible con S3

Usa cualquier AWS SDK para subir y gestionar archivos en IPFS Ninja. Apunta tu cliente S3 a https://s3.ipfs.ninja con tu clave API como credenciales.

https://s3.ipfs.ninja

Operación S3	Descripción
PutObject	Subir un archivo a IPFS
GetObject	Descargar un archivo
HeadObject	Obtener metadatos de archivo
DeleteObject	Eliminar el pin y borrar un archivo
ListObjectsV2	Listar archivos con filtrado por prefijo
CreateMultipartUpload	Iniciar una subida multipart (hasta 5 GB)
UploadPart	Subir una parte
CompleteMultipartUpload	Finalizar la subida multipart
ListBuckets	Listar tus gateways
CreateBucket	Crear un gateway (los nombres de bucket son únicos globalmente — devuelve BucketAlreadyExists si ya está en uso)
DeleteBucket	Eliminar un gateway
PutBucketCors	Configurar reglas CORS por bucket (necesario para el uso del SDK en navegador)
GetBucketCors	Leer la configuración CORS actual de un bucket
DeleteBucketCors	Eliminar todas las reglas CORS de un bucket

Consulta Compatibilidad con S3 para la documentación completa, ejemplos de código y guías de migración.