/api/v0/name/resolve

Resolve IPNS names.

Arguments

• arg [string]: The IPNS name to resolve. Defaults to your node's peerID. Required: no.

• recursive [bool]: Resolve until the result is not an IPNS name. Default: true. Required: no.

• nocache [bool]: Do not use cached entries. Required: no.

• dht-record-count [uint]: Number of records to request for DHT resolution. Default: 16. Required: no.

• dht-timeout [string]: Max time to collect values during DHT resolution e.g. "30s". Pass 0 for no timeout. Default: 1m0s. Required: no.

• stream [bool]: Stream entries as they are found. Required: no.

Response

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

{
  "Path": "<string>"
}

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/name/resolve?arg=<name>&recursive=true&nocache=<value>&dht-record-count=16&dht-timeout=1m0s&stream=<value>"