IPFS · Schema

Pin

Pin object

IPFSDistributed StorageContent-AddressedDecentralizedPeer-to-PeerFile StorageDAGPinningGateway

Properties

Name Type Description
cid string Content Identifier (CID) to be pinned recursively
name string Optional name for pinned data; can be used for lookups later
origins object
meta object
View JSON Schema on GitHub

JSON Schema

pin.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://ipfs.tech/schemas/pinning/pin",
  "title": "Pin",
  "description": "Pin object",
  "type": "object",
  "required": [
    "cid"
  ],
  "properties": {
    "cid": {
      "description": "Content Identifier (CID) to be pinned recursively",
      "type": "string",
      "example": "QmCIDToBePinned"
    },
    "name": {
      "description": "Optional name for pinned data; can be used for lookups later",
      "type": "string",
      "maxLength": 255,
      "example": "PreciousData.pdf"
    },
    "origins": {
      "$ref": "#/components/schemas/Origins"
    },
    "meta": {
      "$ref": "#/components/schemas/PinMeta"
    }
  }
}