IPNS

Resolves an IPNS name to its current target CID.

Looks up the current CID that an IPNS name points to. Returns the resolved CID, validity information, and sequence number.

See also:.*

get/api/ipns/resolve/{name}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ipns/resolve/{name}
  • Auth: none declared

Path parameters

namestring required

IPNS name (peer ID). Example: 12D3KooW...

Query parameters

check_routingstring

Whether to verify routing through the IPFS network. 1 = verify (queries DHT), 0 = local only. Default: 0

Response

IPNS resolve result

expiredboolean required
expiresstring date-time required
namestring required
pathstring required
sequenceinteger required
valuestring required

Changes

    • info

      added the non-success response with the status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status