pin_add

/api/v0/pin/add

Pin objects to local storage.

Request

Syntax

curl "https://ipfs.infura.io:5001/api/v0/pin/add?arg=<ipfs-path>&recursive=true&progress=<value>" \
  -X POST \
  -u "<API_KEY>:<API_KEY_SECRET>"

Example

curl "https://ipfs.infura.io:5001/api/v0/pin/add?arg=QmfQ5QAjvg4GtA3wg3adpnDJug8ktA1BxurVqBD8rtgVjM" \
  -X POST \
  -u "PROJECT_ID:PROJECT_SECRET"

Request parameters

• arg [Required] - Path to objects to be pinned.
• recursive [Optional] - Recursively pin the object linked to by the specified objects. 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": ["QmSTkR1kkqMuGEeBS49dxVJjgHRMH6cUYa7D3tcHDQ3ea3"]
}

Result fields

• Pins - An array of Pin hashes.