Generate Pinata API Key

Create a Pinata API key

POST /users/generateApiKey

Generate Pinata API Key

cURL

curl --request POST \
  --url https://api.pinata.cloud/users/generateApiKey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keyName": "<string>",
  "permissions": {
    "admin": true,
    "endpoints": {
      "data": {
        "pinList": true,
        "userPinnedDataTotal": true
      },
      "pinning": {
        "hashMetadata": true,
        "hashPinPolicy": true,
        "pinByHash": true,
        "pinFileToIPFS": true,
        "pinJSONToIPFS": true,
        "pinJobs": true,
        "unpin": true,
        "userPinPolicy": true
      }
    }
  },
  "maxUses": 123
}
'

import requests

url = "https://api.pinata.cloud/users/generateApiKey"

payload = {
    "keyName": "<string>",
    "permissions": {
        "admin": True,
        "endpoints": {
            "data": {
                "pinList": True,
                "userPinnedDataTotal": True
            },
            "pinning": {
                "hashMetadata": True,
                "hashPinPolicy": True,
                "pinByHash": True,
                "pinFileToIPFS": True,
                "pinJSONToIPFS": True,
                "pinJobs": True,
                "unpin": True,
                "userPinPolicy": True
            }
        }
    },
    "maxUses": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    keyName: '<string>',
    permissions: {
      admin: true,
      endpoints: {
        data: {pinList: true, userPinnedDataTotal: true},
        pinning: {
          hashMetadata: true,
          hashPinPolicy: true,
          pinByHash: true,
          pinFileToIPFS: true,
          pinJSONToIPFS: true,
          pinJobs: true,
          unpin: true,
          userPinPolicy: true
        }
      }
    },
    maxUses: 123
  })
};

fetch('https://api.pinata.cloud/users/generateApiKey', 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/users/generateApiKey",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keyName' => '<string>',
    'permissions' => [
        'admin' => true,
        'endpoints' => [
                'data' => [
                                'pinList' => true,
                                'userPinnedDataTotal' => true
                ],
                'pinning' => [
                                'hashMetadata' => true,
                                'hashPinPolicy' => true,
                                'pinByHash' => true,
                                'pinFileToIPFS' => true,
                                'pinJSONToIPFS' => true,
                                'pinJobs' => true,
                                'unpin' => true,
                                'userPinPolicy' => true
                ]
        ]
    ],
    'maxUses' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.pinata.cloud/users/generateApiKey"

	payload := strings.NewReader("{\n  \"keyName\": \"<string>\",\n  \"permissions\": {\n    \"admin\": true,\n    \"endpoints\": {\n      \"data\": {\n        \"pinList\": true,\n        \"userPinnedDataTotal\": true\n      },\n      \"pinning\": {\n        \"hashMetadata\": true,\n        \"hashPinPolicy\": true,\n        \"pinByHash\": true,\n        \"pinFileToIPFS\": true,\n        \"pinJSONToIPFS\": true,\n        \"pinJobs\": true,\n        \"unpin\": true,\n        \"userPinPolicy\": true\n      }\n    }\n  },\n  \"maxUses\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pinata.cloud/users/generateApiKey")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keyName\": \"<string>\",\n  \"permissions\": {\n    \"admin\": true,\n    \"endpoints\": {\n      \"data\": {\n        \"pinList\": true,\n        \"userPinnedDataTotal\": true\n      },\n      \"pinning\": {\n        \"hashMetadata\": true,\n        \"hashPinPolicy\": true,\n        \"pinByHash\": true,\n        \"pinFileToIPFS\": true,\n        \"pinJSONToIPFS\": true,\n        \"pinJobs\": true,\n        \"unpin\": true,\n        \"userPinPolicy\": true\n      }\n    }\n  },\n  \"maxUses\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pinata.cloud/users/generateApiKey")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keyName\": \"<string>\",\n  \"permissions\": {\n    \"admin\": true,\n    \"endpoints\": {\n      \"data\": {\n        \"pinList\": true,\n        \"userPinnedDataTotal\": true\n      },\n      \"pinning\": {\n        \"hashMetadata\": true,\n        \"hashPinPolicy\": true,\n        \"pinByHash\": true,\n        \"pinFileToIPFS\": true,\n        \"pinJSONToIPFS\": true,\n        \"pinJobs\": true,\n        \"unpin\": true,\n        \"userPinPolicy\": true\n      }\n    }\n  },\n  \"maxUses\": 123\n}"

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

Authorizations

Authorization · string · header · required

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

Body

application/json

Body is comprised of keyName, permissions, and maxUses (optional).

keyName · string · required

permissions · object · required

Show child attributes

maxUses · integer

Response

200

application/json

{ "pinata_api_key": "KEY", "pinata_api_secret": "SECRET", "JWT": "JWT" }