hashMetadata
ipfsPinHash
- A string for a valid IPFS Hash that you have pinned on Pinata.metadata
A JSON object containing the following:name
(optional) - A new name that Pinata will associate with this particular hash.keyvalues
(optional) - A JSON object with the updated keyvalues you want associated with the hash provided (see more below)hashPinPolicy
ipfsPinHash
- A string for a valid IPFS Hash that you have pinned on Pinata.newPinPolicy
A JSON object with a new Pin Policy for the hash.pinByHash
hashToPin
- A string for a valid IPFS Hash (Also known as a CID)options
(optional): A JSON object that can contain following keyvalues:pinataMetadata
(optional): A JSON object with optional metadata for the hash being pinnedpinataOptions
hostNodes
(optional): An array of multiaddresses for nodes that are currently hosting the content to be pinnedcustomPinPolicy
A JSON object with a new Pin Policy for the hash.pinFileToIPFS
readableStream
- A readableStream of the file to be addedoptions
(optional): A JSON object that can contain the following keyvalues:pinataMetadata
(optional): A JSON object with optional metadata for the file being pinnedpinataOptions
(optional): A JSON object with additional options for the file being pinnedpinFromFS
sourcePath
- The location on your local filesystem that should be read from.options
(optional): A JSON object that can contain the following keyvalues:pinataMetadata
(optional): A JSON object with optional metadata for the file being pinnedpinataOptions
(optional): A JSON object with additional options for the file being pinnedpinJobs
filters
(optional): An object that can consist of the following optional query parameters:sort
(optional): How you wish for the records in the response to be sorted. Valid inputs for this are:'ASC'
'DESC'
status
(optional): What the current status of the record is in the pin queue. Valid statuses and their meanings are:prechecking
- Pinata is running preliminary validations on your pin request.searching
- Pinata is actively searching for your content on the IPFS network. This may take some time if your content is isolated.retrieving
- Pinata has located your content and is now in the process of retrieving it.expired
- Pinata wasn't able to find your content after a day of searching the IPFS network. Please make sure your content is hosted on the IPFS network before trying to pin again.over_free_limit
- Pinning this object would put you over the free tier limit. Please add a credit card to continue pinning content.over_max_size
- This object is too large of an item to pin. If you're seeing this, please contact us for a more custom solution.invalid_object
- The object you're attempting to pin isn't readable by IPFS nodes. Please contact us if you receive this, as we'd like to better understand what you're attempting to pin.bad_host_node
- The provided host node(s) were either invalid or unreachable. Please make sure all provided host nodes are online and reachable.ipfs_pin_hash
(optional): A string for a valid IPFS hash (also known as a CID) to search forlimit
(optional): Limit the amount of results returned per page of results (default is 5, and max is also 1000)offset
(optional): Provide the record offset for records being returned. This is how you retrieve records on additional pages (default is 0)pinJSONToIPFS
body
- Valid JSON you wish to pin to IPFSoptions
(optional): A JSON object that can contain the following keyvalues:metadata
(optional): A JSON object with optional metadata for the hash being pinnedpinataOptions
(optional): A JSON object with additional options for the JSON being pinnedunpin
hashToUnpin
- the hash of the content you wish to unpin from PinatauserPinPolicy
newPinPolicy
A JSON object with a new Pin Policy for the hash.testAuthentication
pinList
filters
(optional): An object that can consist of the following optional query parameters:hashContains
(optional): A string of alphanumeric characters that desires hashes must containpinStart
(optional): The earliest date the content is allowed to have been pinned. Must be a valid ISO_8601 date.pinEnd
(optional): The earliest date the content is allowed to have been pinned. Must be a valid ISO_8601 date.unpinStart
(optional): The earlist date the content is allowed to have been unpinned. Must be a valid ISO_8601 date.unpinEnd
(optional): The latest date the content is allowed to have been unpinned. Must be a valid ISO_8601 date.pinSizeMin
(optional): The minimum byte size that pin record you're looking for can havepinSizeMax
(optional): The maximum byte size that pin record you're looking for can havestatus
(optional): Filter pins using one of the following options'all'
(Records for both pinned and unpinned content will be returned)'pinned'
(Only records for pinned content will be returned)'unpinned'
(Only records for unpinned content will be returned)pageLimit
(optional): Limit the amount of results returned per page of results (default is 10, and max is 1000)pageOffset
(optional): Provide the record offset for records being returned. This is how you retrieve records on additional pages (default is 0)metadata
(optional): A JSON object that can be used to find records for content that had optional metadata included when it was added to Pinata. The metadata object is formatted as follows:name
(optional): If provided, any records returned must have a name that contains the string provided for the 'name'.keyvalues
(optional): Each keyvalue provided in this object have both a value
and op
value
(required): This is the value which will be filtered onop
(required): This is the filter operation that will be applied to the value
that was provided. Valid op values are:'gt'
(greater than the value provided)'gte'
(greater than or equal to the value provided)'lt'
(less than the value provided)'lte'
(less than or equal to the value provided)'ne'
(not equal to the value provided)'eq'
(equal to the value provided)'between'
(between the two values provided) - NOTE - This also requires a secondValue
be provided as seen in the example below'notBetween'
(not between the two values provided) - NOTE - This also requires a secondValue
be provided as seen in the example below'like'
(like the value provided)'notLike'
(not like the value provided)'iLike'
(case insensitive version of like
)'notILike'
(case insensitive version of notLike
)'regexp'
(filter the value provided based on a provided regular expression)'iRegexp'
(case insensitive version of regexp)userPinnedDataTotal
/ip4/123.456.78.90/tcp/4001/ipfs/QmAbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQr
0
- CIDv01
- CIDv1true
false