Referència de l'API

Tots els endpoints, paràmetres, formats de sol·licitud/resposta i codis d'error.

Base URL

https://api.ipfs.ninja

Totes les sol·licituds requereixen una API key mitjançant la capçalera X-Api-Key. Consulteu Autenticació per a més detalls.

Endpoints

Method	Path	Descripció	Pàgina
POST	/upload/new	Pujar un fitxer a IPFS	Fitxers
GET	/upload/list	Llistar fitxers pujats	Fitxers
GET	/file/:cid	Obtenir metadata del fitxer per CID	Fitxers
PUT	/files/:cid/name	Canviar el nom d'un fitxer	Fitxers
PUT	/files/:cid/move	Moure un fitxer a una carpeta	Carpetes
POST	/pin	Fixar CID existent de la xarxa IPFS (admet pistes de swarm-connect)	Fixació
GET	/pin/:cid	Comprovar estat de fixació	Fixació
POST	/folders	Crear carpeta	Carpetes
GET	/folders	Llistar carpetes	Carpetes
PUT	/folders/:folderId	Actualitzar carpeta	Carpetes
DELETE	/folders/:folderId	Eliminar carpeta	Carpetes
POST	/folders/:folderId/snapshot	Fer un snapshot d'una carpeta a un CID de directori	Carpetes
PUT	/folders/:folderId/cors	Establir la configuració CORS per bucket	Carpetes
GET	/folders/:folderId/cors	Obtenir la configuració CORS per bucket	Carpetes
DELETE	/folders/:folderId/cors	Eliminar la configuració CORS per bucket	Carpetes
GET	/user/profile	Obtenir perfil d'usuari	Perfil
POST	/apikeys	Crear API key	API Keys
GET	/apikeys	Llistar API keys	API Keys
DELETE	/apikeys/:key	Eliminar API key	API Keys
GET	/analytics	Analítiques d'ús	Analítiques
PUT	/gateway-settings	Actualitzar configuració del gateway	Gateways
POST	/gateway-tokens	Crear gateway token	Gateways
GET	/gateway-tokens	Llistar gateway tokens	Gateways
DELETE	/gateway-tokens/:prefix	Eliminar gateway token	Gateways
POST	/upload/signed-url	Generar token de pujada signat	Tokens Signats
GET	/signed-tokens	Llistar tokens signats	Tokens Signats
DELETE	/signed-tokens/:tokenId	Revocar token signat	Tokens Signats
GET	/image/:cid	Optimitzar imatge sobre la marxa	Optimització d'Imatge

CIDv1 per defecte

Les pujades i fixacions retornen CIDv1 modern (bafk… per a contingut petit d'un sol bloc, bafy… per a fitxers i directoris més grans) seguint el perfil IPIP-0499 unixfs-v1-2025. Els CID Qm… heretats de pujades anteriors continuen sent completament resolubles arreu — Qm… és una entrada vàlida per a qualsevol endpoint que accepti un CID.

API compatible amb S3

Utilitzeu qualsevol AWS SDK per pujar i gestionar fitxers a IPFS Ninja. Apunteu el vostre client S3 a https://s3.ipfs.ninja amb la vostra API key com a credencials.

https://s3.ipfs.ninja

Operació S3	Descripció
PutObject	Pujar un fitxer a IPFS
GetObject	Descarregar un fitxer
HeadObject	Obtenir metadata del fitxer
DeleteObject	Desfixar i eliminar un fitxer
ListObjectsV2	Llistar fitxers amb filtratge per prefix
CreateMultipartUpload	Iniciar una pujada multipart (fins a 5 GB)
UploadPart	Pujar una part
CompleteMultipartUpload	Finalitzar la pujada multipart
ListBuckets	Llistar els vostres gateways
CreateBucket	Crear un gateway (els noms de bucket són únics globalment — retorna BucketAlreadyExists si ja està agafat)
DeleteBucket	Eliminar un gateway
PutBucketCors	Configurar regles CORS per bucket (necessari per a l'ús de l'SDK des del navegador)
GetBucketCors	Llegir la configuració CORS actual d'un bucket
DeleteBucketCors	Eliminar totes les regles CORS d'un bucket

Consulteu Compatibilitat S3 per a la documentació completa, exemples de codi i guies de migració.