/api/v0/key/rm

Remove a keypair.

Arguments

  • arg [string]: names of keys to remove Required: yes.

  • l [bool]: Show extra information about keys. Required: no.

  • ipns-base [string]: Encoding used for keys: Can either be a multibase encoded CID or a base58btc encoded multihash. Takes {b58mh|base36|k|base32|b...}. Default: base36. Required: no.

Response

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

{
  "Keys": [
    {
      "Id": "<string>",
      "Name": "<string>"
    }
  ]
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/key/rm?arg=<name>&l=<value>&ipns-base=base36"

Last updated