v1/pinning REST API Endpoint

Body Parameters

cid

string

REQUIRED

name

string

REQUIRED

origins

array

Returns

requestId

string

status

string

cid

string

name

string

origins

string

meta

object

test

string

morevalue

object

location

string

uuid

string

createdAt

string

updatedAt

string

contentType

null

size

null

Request

curl --location 'https://api.quicknode.com/ipfs/rest/v1/pinning' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '  {
    "cid": "QmWTqpfKyPJcGuWWg73beJJiL6FrCB5yX8qfcCF4bHanes",
    "name": "image.png",
    "origins": ["/ip4/123.12.113.142/tcp/4001/p2p/SourcePeerId", "/ip4/123.12.113.114/udp/4001/quic/p2p/SourcePeerId"],
    "meta": { "test": "mycooltest", "morevalue": { "location": "/home" } }
  }'

var myHeaders = new Headers();
myHeaders.append("x-api-key", "YOUR_API_KEY");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "cid": "QmWTqpfKyPJcGuWWg73beJJiL6FrCB5yX8qfcCF4bHanes",
  "name": "image.png",
  "origins": [
    "/ip4/123.12.113.142/tcp/4001/p2p/SourcePeerId",
    "/ip4/123.12.113.114/udp/4001/quic/p2p/SourcePeerId"
  ],
  "meta": {
    "test": "mycooltest",
    "morevalue": {
      "location": "/home"
    }
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.quicknode.com/ipfs/rest/v1/pinning", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests
import json

url = "https://api.quicknode.com/ipfs/rest/v1/pinning"

payload = json.dumps({
  "cid": "QmWTqpfKyPJcGuWWg73beJJiL6FrCB5yX8qfcCF4bHanes",
  "name": "image.png",
  "origins": [
    "/ip4/123.12.113.142/tcp/4001/p2p/SourcePeerId",
    "/ip4/123.12.113.114/udp/4001/quic/p2p/SourcePeerId"
  ],
  "meta": {
    "test": "mycooltest",
    "morevalue": {
      "location": "/home"
    }
  }
})
headers = {
  'x-api-key': 'YOUR_API_KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "json"
require "net/http"

url = URI("https://api.quicknode.com/ipfs/rest/v1/pinning")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = "YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "cid": "QmWTqpfKyPJcGuWWg73beJJiL6FrCB5yX8qfcCF4bHanes",
  "name": "image.png",
  "origins": [
    "/ip4/123.12.113.142/tcp/4001/p2p/SourcePeerId",
    "/ip4/123.12.113.114/udp/4001/quic/p2p/SourcePeerId"
  ],
  "meta": {
    "test": "mycooltest",
    "morevalue": {
      "location": "/home"
    }
  }
})

response = https.request(request)
puts response.read_body

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free

v1/pinning REST API Endpoint

Loading...

Body Parameters

Returns