Skip to main content

v1/pinning/{requestId} REST API Endpoint

Updates the metadata of a pinned object

Updated on
Oct 19, 2023

v1/pinning/{requestId} REST API Endpoint

Path Parameters

requestId
string
REQUIRED
Represents the ID of the request associated with the pinned object that needs to be updated, which can be obtained from querying all pinned object by using 'Get All PinnedObjects' method

Body Parameters

cid
string
REQUIRED
Represents the Content Identifier (CID) that identifies the pinned object
name
string
REQUIRED
Specifies the new name associated with the pinned object. The length of the name should be less than or equal to 255 characters
origins
array
A list of multi-addresses representing the origins of the pinned object
meta
object
Contains details about the updated metadata of the pinned object
test
string
Represents a test-related detail about the pinned object
morevalue
object
Contains additional details about the pinned object
location
string
Describes the updated location associated with the pinned object

Returns

requestId
string
Represents the ID of the request
status
string
Describes the status of the pinned object after the update
cid
string
Represents the CID associated with the pinned object
name
string
Specifies the updated name associated with the pinned object
origins
string
A list of string values representing the origins of the pinned object
meta
object
Contains details about the updated metadata of the pinned object
test
string
Represents a test-related detail about the pinned object
morevalue
object
Contains additional details about the pinned object
location
string
Describes the updated location associated with the pinned object
uuid
string
Represents the UUID (Universally Unique Identifier) of the pinned object
createdAt
string
Specifies the date and time when the pinned object was created
updatedAt
string
Indicates the date and time when the pinned object was last updated
contentType
null
Represents the content type of the pinned object
size
null
Represents the size of the pinned object
Request
1
curl --location --request PATCH 'https://api.quicknode.com/ipfs/rest/v1/pinning/{requestId}' \
2
--header 'x-api-key: YOUR_API_KEY' \
3
--header 'Content-Type: application/json' \
4
--data '  {
5
    "cid": "QmWTqpfKyPJcGuWWg73beJJiL6FrCB5yX8qfcCF4bHanes",
6
    "name": "newimage.png",
7
    "origins": [],
8
    "meta": { "test": "my meta data" }
9
  }'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free