Pinning

Pinnen Sie bestehende IPFS-Inhalte an Ihr Konto. Wenn Sie einen CID pinnen, ruft unser Cluster den Inhalt aus dem IPFS-Netzwerk ab und hält ihn permanent verfügbar.

Nach CID pinnen

POST /pin

Parameter	Typ	Erforderlich	Beschreibung
cid	string	Ja	IPFS Content Identifier (beginnt mit Qm oder bafy).
description	string	Nein	Kurze Beschreibung als Referenz.
metadata	object	Nein	Benutzerdefinierte Schlüssel-Wert-Paare, die an den Pin angehängt werden. Max. 10 Schlüssel. Schlüssel müssen alphanumerisch oder Unterstrich sein, 1-64 Zeichen. Werte müssen Strings sein, max. 256 Zeichen pro Wert. Gesamte Metadatengröße darf 4 KB nicht überschreiten.

Beispielanfrage

curl -X POST https://api.ipfs.ninja/pin \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "description": "NFT metadata",
    "metadata": {
      "collection": "my-nfts",
      "token_id": "42"
    }
  }'

Antwort 202 Accepted

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinning",
  "description": "NFT metadata",
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

TIP

Pinning ist asynchron. Die Antwort wird sofort mit dem Status pinning zurückgegeben. Fragen Sie den Status-Endpunkt ab, um zu prüfen, wann das Pinning abgeschlossen ist.

Pin-Status prüfen

GET /pin/:cid

Parameter	Typ	Erforderlich	Beschreibung
cid	string	Ja	Der CID, den Sie prüfen.

Antwort 200 OK

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinned",
  "sizeMB": 0.042,
  "fileName": "NFT metadata",
  "pinnedAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

Statuswerte

Status	Bedeutung
pinning	Inhalt wird aus dem IPFS-Netzwerk abgerufen. Fragen Sie in einigen Sekunden erneut ab.
pinned	Inhalt ist gepinnt und über Ihr Konto und Gateway verfügbar.
failed	Inhalt konnte im IPFS-Netzwerk nicht gefunden werden. Der CID ist möglicherweise ungültig oder der Inhalt ist nicht mehr verfügbar.

Wie Pinning funktioniert

1. Sie senden einen CID über POST /pin
2. Unser IPFS-Cluster durchsucht das Netzwerk nach Knoten, die den Inhalt haben
3. Der Cluster lädt den Inhalt herunter und pinnt ihn lokal
4. Sobald gepinnt, erscheint die Datei in Ihrer Dateiliste und ist über das Gateway zugänglich
5. Die Speichernutzung wird nach Abschluss des Pinnings erfasst

WARNING

Die Pinning-Zeit hängt von der Dateigröße und der Netzwerkverfügbarkeit ab. Kleine Dateien werden typischerweise in Sekunden gepinnt. Große Dateien oder selten gepinnte Inhalte können Minuten dauern.

Speicher

Gepinnter Inhalt zählt zum Speicherlimit Ihres Plans. Die Dateigröße wird erfasst, wenn das Pinning abgeschlossen ist — Sie können ein Pinning starten, auch wenn Ihr Speicher fast voll ist, aber weitere Uploads werden blockiert, wenn der Pin dazu führt, dass Sie das Limit überschreiten.