/api/v0/pin/add

Pin objects to local storage.

Arguments

• arg [string]: Path to object(s) to be pinned. Required: yes.

• recursive [bool]: Recursively pin the object linked to by the specified object(s). Default: true. Required: no.

• name [string]: An optional name for created pin(s). Required: no.

• progress [bool]: Show progress. Required: no.

Response

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

{
  "Pins": [
    "<string>"
  ],
  "Progress": "<int>"
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/pin/add?arg=<ipfs-path>&recursive=true&name=<value>&progress=<value>"