/api/v0/pin/remote/add

Pin object to remote pinning service.

Arguments

• arg [string]: CID or Path to be pinned. Required: yes.

• service [string]: Name of the remote pinning service to use (mandatory). Required: no.

• name [string]: An optional name for the pin. Required: no.

• background [bool]: Add to the queue on the remote service and return immediately (does not wait for pinned status). Default: false. Required: no.

Response

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

{
  "Cid": "<string>",
  "Name": "<string>",
  "Status": "<string>"
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/pin/remote/add?arg=<ipfs-path>&service=<value>&name=<value>&background=false"