IPNS

Publish to IPNS

Publishes content to an IPNS key.

Updates an IPNS key to point to a new CID. Allows updating mutable addresses without changing the URL. Supports setting TTL for record validity.

Request

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

cidstring required

key_idinteger required

ttlstring

IPNS publish result

namestring required

publishedstring date-time required

sequenceinteger required

validitystring date-time required

valuestring required

Sep 20, 202606e0fa4f446e Revision changes
- info
  added the non-success response with the status
Jul 18, 2026b97dd0465ab3 Revision changes
- 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