List Pin By CID Jobs

List all currently running pinByHash jobs

GET /pinning/pinJobs

List Pin By CID Jobs

cURL

curl --request GET \
  --url https://api.pinata.cloud/pinning/pinJobs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pinata.cloud/pinning/pinJobs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pinata.cloud/pinning/pinJobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pinata.cloud/pinning/pinJobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinata.cloud/pinning/pinJobs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pinata.cloud/pinning/pinJobs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pinata.cloud/pinning/pinJobs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "count": 123,
  "rows": [
    {
      "id": "<string>",
      "ipfs_pin_hash": "<string>",
      "date_queued": "<string>",
      "name": "<string>",
      "status": "<string>",
      "keyvalues": null,
      "host_nodes": [
        "<string>"
      ],
      "pin_policy": {
        "regions": [
          {
            "id": "<string>",
            "desiredReplicationCount": 123
          }
        ],
        "version": 123
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort · string

Values include ASC or DESC

Example:

"ASC"

status · enum<string>

Filter by the status of the job in the pinning queue

Available options: prechecking, retrieving, expired, over_free_limit, over_max_size, invalid_object, bad_host_node, backfilled

Example:

"retrieving"

ipfs_pin_hash · string

CID of the file to be pinned

Example:

"CID"

limit · integer

Number of jobs to return. Default is 5 and 1000 is the maximum

Example:

5

offset · integer

Provide the record offset for records being returned. This is how you retrieve records on additional pages (default is 0)

Example:

0

Response

200 - application/json

{ count: (this is the total number of pin job records that exist for the query filters you passed in), rows: [ { id: (the id for the pin job record), ipfs_pin_hash: (the IPFS multi-hash for the content you pinned), date_queued: (The date this hash was initially queued to be pinned - represented in ISO 8601 format), status: (The current status for the pin job), name: (If you passed in a name for your hash, it will be listed here), keyvalues: (If you passed in keyvalues for your hash, they will be listed here), host_nodes: (If you provided host nodes for your hash, they will be listed here), pin_policy: Once this content has been found, this is the pin policy that will be used for replications }, { same record format as above } . . . ] }

count · integer

rows · object[]

Show child attributes