Skip to main content

v1/s3/put-object REST API Endpoint

Upload a new object to IPFS and pins it for permanent storage on the network.

Updated on
Dec 20, 2023

v1/s3/put-object REST API Endpoint

Query Parameters

Body
file
REQUIRED
Indicates that the content of the file is being sent as the request body
Key
string
REQUIRED
The key or name under which the object will be stored
ContentType
string
REQUIRED
Indicates the content type of the object being uploaded. Possible values include application/pdf, audio/mpeg, image/jpeg, image/png, or text/plain

Returns

requestid
string
Represents the ID of the request
status
string
Describes the status of the uploaded object
created
string
Specifies the date and time when the uploaded object was created
pin
object
The details of the uploaded object
cid
string
Represents the CID associated with the uploaded object
name
string
Specifies the name associated with the uploaded object
origins
array
A list of string values representing the origins of the uploaded object
meta
object
Contains details about the meta information of the uploaded object
info
object
The additional information about the uploaded object
size
string
Represents the size of the uploaded object
delegates
string
An array having information about delegates or additional parties involved in the upload process
Request
1
curl --location 'https://api.quicknode.com/ipfs/rest/v1/s3/put-object' \
2
--header 'x-api-key: YOUR_API_KEY' \
3
--form 'Body=@"YOUR_FILE_PATH"' \
4
--form 'Key="YOUR_FILE_NAME"' \
5
--form 'ContentType="YOUR_CONTENT_TYPE"'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free