Users
Generate Pinata API Key
- API Keys
- Blog
- Community
- Introduction
- GETTest Authentication
API Documentation
Authentication
Users
Generate Pinata API Key
Create a Pinata API key
POST
/
users
/
generateApiKey
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
object
keyName
string
*
keyName
Required
string
permissions
object
*
permissions
Required
object
admin
boolean
admin
boolean
endpoints
object
endpoints
object
data
object
data
object
pinList
boolean
pinList
boolean
userPinnedDataTotal
boolean
userPinnedDataTotal
boolean
pinning
object
pinning
object
hashMetadata
boolean
hashMetadata
boolean
hashPinPolicy
boolean
hashPinPolicy
boolean
pinByHash
boolean
pinByHash
boolean
pinFileToIPFS
boolean
pinFileToIPFS
boolean
pinJSONToIPFS
boolean
pinJSONToIPFS
boolean
pinJobs
boolean
pinJobs
boolean
unpin
boolean
unpin
boolean
userPinPolicy
boolean
userPinPolicy
boolean
maxUses
integer
maxUses
integer
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
}'
"<any>"
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
keyName
string
requiredpermissions
object
requiredpermissions.admin
boolean
permissions.endpoints
object
permissions.endpoints.data
object
permissions.endpoints.data.pinList
boolean
permissions.endpoints.data.userPinnedDataTotal
boolean
permissions.endpoints.pinning
object
permissions.endpoints.pinning.hashMetadata
boolean
permissions.endpoints.pinning.hashPinPolicy
boolean
permissions.endpoints.pinning.pinByHash
boolean
permissions.endpoints.pinning.pinFileToIPFS
boolean
permissions.endpoints.pinning.pinJSONToIPFS
boolean
permissions.endpoints.pinning.pinJobs
boolean
permissions.endpoints.pinning.unpin
boolean
permissions.endpoints.pinning.userPinPolicy
boolean
maxUses
integer
Response
200 - application/json
The response is of type any
.
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
}'
"<any>"