pin_add

/api/v0/pin/add

Pin objects to local storage.

REQUEST

Syntax

curl "https://mainnet-rpc.wetez.io/ipfs/$AdminKey/api/v0/pin/add?arg=<ipfs-path>&recursive=true&progress=<value>" \
    -X POST

Example

curl "https://mainnet-rpc.wetez.io/ipfs/$AdminKey/api/v0/pin/add?arg=QmbLfeStdYuXk6AebVuADBTZ1fT77XtPspChaNi7NiQB4u" \
    -X POST

REQUEST PARAMS

• arg [Required] - Path to object(s) to be pinned.

• recursive [Optional] - Recursively pin the object linked to by the specified object(s). The default is true.

• progress [Optional] - Show progress.

RESPONSE

On success, the call to this endpoint returns with 200 and the following body:

BODY

{
    "Pins": ["QmbLfeStdYuXk6AebVuADBTZ1fT77XtPspChaNi7NiQB4u"]
}

RESULT FIELDS

• Pins - An array of Pin hashes.