/api/v0/pin/remote/rm

Remove pins from remote pinning service.

Arguments

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

• name [string]: Remove pins with names that contain provided value (case-sensitive, exact match). Required: no.

• cid [array]: Remove pins for the specified CIDs. Required: no.

• status [array]: Remove pins with the specified statuses (queued,pinning,pinned,failed). Default: [pinned]. Required: no.

• force [bool]: Allow removal of multiple pins matching the query without additional confirmation. Default: false. Required: no.

Response

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

This endpoint returns a `text/plain` response body.

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/pin/remote/rm?service=<value>&name=<value>&cid=<value>&status=[pinned]&force=false"