Référence de l'API

Tous les endpoints, paramètres, formats de requête/réponse et codes d'erreur.

URL de base

https://api.ipfs.ninja

Toutes les requêtes nécessitent une clé API via l'en-tête X-Api-Key. Consultez Authentification pour plus de détails.

Endpoints

Méthode	Chemin	Description	Page
POST	/upload/new	Téléverser un fichier sur IPFS	Fichiers
GET	/upload/list	Lister les fichiers téléversés	Fichiers
GET	/file/:cid	Obtenir les métadonnées d'un fichier par CID	Fichiers
PUT	/files/:cid/name	Renommer un fichier	Fichiers
PUT	/files/:cid/move	Déplacer un fichier dans un dossier	Dossiers
POST	/pin	Épingler un CID existant du réseau IPFS (prend en charge les indices de connexion au swarm)	Épinglage
GET	/pin/:cid	Vérifier le statut d'épinglage	Épinglage
POST	/folders	Créer un dossier	Dossiers
GET	/folders	Lister les dossiers	Dossiers
PUT	/folders/:folderId	Mettre à jour un dossier	Dossiers
DELETE	/folders/:folderId	Supprimer un dossier	Dossiers
POST	/folders/:folderId/snapshot	Créer un instantané d'un dossier sous forme de CID de répertoire	Dossiers
PUT	/folders/:folderId/cors	Définir la configuration CORS par bucket	Dossiers
GET	/folders/:folderId/cors	Obtenir la configuration CORS par bucket	Dossiers
DELETE	/folders/:folderId/cors	Supprimer la configuration CORS par bucket	Dossiers
GET	/user/profile	Obtenir le profil utilisateur	Profil
POST	/apikeys	Créer une clé API	Clés API
GET	/apikeys	Lister les clés API	Clés API
DELETE	/apikeys/:key	Supprimer une clé API	Clés API
GET	/analytics	Statistiques d'utilisation	Statistiques
PUT	/gateway-settings	Mettre à jour les paramètres du gateway	Gateways
POST	/gateway-tokens	Créer un token de gateway	Gateways
GET	/gateway-tokens	Lister les tokens de gateway	Gateways
DELETE	/gateway-tokens/:prefix	Supprimer un token de gateway	Gateways
POST	/upload/signed-url	Générer un token de téléversement signé	Tokens signés
GET	/signed-tokens	Lister les tokens signés	Tokens signés
DELETE	/signed-tokens/:tokenId	Révoquer un token signé	Tokens signés
GET	/image/:cid	Optimiser une image à la volée	Optimisation d'images

CIDv1 par défaut

Les téléversements et épinglages renvoient désormais un CIDv1 moderne (bafk… pour le contenu à bloc unique de petite taille, bafy… pour les fichiers volumineux et les répertoires) conformément au profil IPIP-0499 unixfs-v1-2025. Les CID Qm… hérités des téléversements précédents restent entièrement résolubles partout — Qm… est une entrée valide pour tout endpoint acceptant un CID.

API compatible S3

Utilisez n'importe quel SDK AWS pour téléverser et gérer des fichiers sur IPFS Ninja. Pointez votre client S3 vers https://s3.ipfs.ninja avec votre clé API comme identifiants.

https://s3.ipfs.ninja

Opération S3	Description
PutObject	Téléverser un fichier sur IPFS
GetObject	Télécharger un fichier
HeadObject	Obtenir les métadonnées d'un fichier
DeleteObject	Désépingler et supprimer un fichier
ListObjectsV2	Lister les fichiers avec filtrage par préfixe
CreateMultipartUpload	Démarrer un téléversement multipart (jusqu'à 5 Go)
UploadPart	Téléverser une partie
CompleteMultipartUpload	Terminer le téléversement multipart
ListBuckets	Lister vos gateways
CreateBucket	Créer un gateway (les noms de bucket sont uniques au niveau mondial — renvoie BucketAlreadyExists si le nom est pris)
DeleteBucket	Supprimer un gateway
PutBucketCors	Configurer les règles CORS par bucket (requis pour une utilisation via SDK navigateur)
GetBucketCors	Lire la configuration CORS actuelle d'un bucket
DeleteBucketCors	Supprimer toutes les règles CORS d'un bucket

Consultez Compatibilité S3 pour la documentation complète, des exemples de code et des guides de migration.