Skip to main content

v1/pinning/{requestId} REST API Endpoint

Get a pinned object's information and status.

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, which can be obtained from querying all pinned object by using 'Get All PinnedObjects' method

Returns

id
integer
Represents the ID of the pinned object
uuid
string
Represents the Universally Unique Identifier (UUID) 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
requestId
string
Represents the ID of the request associated with the pinned object
cid
string
Represents the Content Identifier (CID) associated with the pinned object
name
string
Specifies the name associated with the pinned object
contentType
string
Represents the content type of the pinned object
size
string
Represents the size of the pinned object
origins
array
Represents the origins of the pinned object
status
string
Describes the status of the pinned object
meta
object
Contains details about the metadata of the pinned object
Request
1
curl --location 'https://api.quicknode.com/ipfs/rest/v1/pinning/{requestId}' \
2
--header 'x-api-key: YOUR_API_KEY'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free