4EVERLAND Documents
HomeTwitterDiscordBlogs
  • Welcome to 4EVERLAND
  • Get started
    • Our Features
    • Quick Start Guide
      • Registration
      • Login options
        • MetaMask
        • OKX Wallet
        • Binance Web3 Wallet
        • Bitget Wallet
        • Phantom
        • Petra
        • Lilico
      • Usage Introduction
      • Dashboard stats
      • Account
        • Linking Your EVM Wallet to 4EVERLAND Account
        • Balance Alert
    • Billing and Pricing
      • What is LAND?
      • How to Obtain LAND?
      • Pricing Model
      • Q&As
    • Tokenomics
  • HOSITNG
    • What is Hosting?
      • IPFS Hosting
      • Arweave Hosting
        • Auto-Generation of Manifest
      • Internet Computer Hosting
      • Greenfield Hosting
    • Guides
      • Creating a Deployment
        • With Git
        • With IPFS Hash
        • With a Template
      • Site Deployment
      • Domain Management
        • DNS Setup Guide
        • ENS Setup Guide
        • SNS Setup Guide
          • The gateway: 4sol.xyz
        • SPACE ID Setup Guide
      • Project Setting
        • Git
      • Troubleshooting
      • Common Frameworks
    • Hosting Templates Centre
      • Templates Configuration File
    • Quick Addition
      • Implement Github 4EVER Pin
      • Github Deployment Button
    • Hosting API
      • Create Project API
      • Deploy Project API
      • Get Task Info API
      • IPNS Deployment Update API
    • Hosting CLI
  • Storage
    • Bucket
      • IPFS Bucket
        • Get Root CID - Snapshots
      • Arweave Bucket
        • Path Manifests
          • Instructions for Building Manifest
          • Auto-Generation of Manifest
        • Arweave Tags
        • Unleash Arweave
      • Guides
      • Bucket API - S3 Compatible
        • Coding Examples
          • AWS SDK - Go (Golang)
          • AWS SDK - Java
          • AWS SDK - JavaScript
          • AWS SDK - .NET
          • AWS SDK - PHP
          • AWS SDK - Python
          • AWS SDK - Ruby
        • S3 Tags Instructions
      • 4EVER Security Token Service API
      • Bucket Tools
      • Bucket Gateway Optimizer
    • 4EVER Pin
      • Guides
      • Pinning Services API
      • IPFS Migrator
    • Storage SDK
  • Gateways
    • IPFS Gateway
    • IC Gateway
    • Arweave Gateway
    • Dedicated Gateways
      • Gateway Access Controls
      • Video Streaming
      • IPFS Image Optimizer
    • IPNS Manager
      • IPNS Manager API
  • RPC
    • Guides
    • API Keys
    • JSON Web Token (JWT)
    • What's CUs/CUPS
    • WebSockets
    • Archive Node
    • Debug API
    • Chains RPC
      • BSC / opBNB
      • Ethereum
      • Optimism
      • Polygon
      • Taiko
  • AI
    • AI RPC
      • Quick Start
      • Models
      • API Keys
      • Requests & Responses
      • Parameters
    • 4EVER Chat
  • RaaS - Beta
    • What's Rollups?
    • 4EVER Rollup Stack
  • DePIN
    • 4EVER Network
    • Storage Nodes
  • More
    • Use Cases
      • Livepeer
      • Lens Protocol
      • Optopia.ai
      • Linear Finance
      • Snapshot
      • Tape
      • Taiko
      • Hey.xyz
      • SyncSwap
    • Community
    • Tutorials
    • Security
    • 4EVERLAND FAQ
Powered by GitBook
On this page
  1. Gateways
  2. IPNS Manager

IPNS Manager API

4EVERLAND IPNS API can help with IPNS creation, retrieval, CID preservation and publishing, etc.

Last updated 10 months ago

Auth Token

An Auth Token is a token used for identity verification and authorization purposes. To utilize the 4EVERLAND IPNS Manager API, you need to first create an Auth Token on the 4EVERLAND Dashboard.

You can do so by navigating to your 4EVERLAND Dashboard, selecting Gateway > Auth Token, and then clicking "Generate".

Create IPNS Name

List IPNS Names

The time parameter corresponding to lifetime is the maximum period for which the node in the network will keep the ipfs path, in fact the IPNS corresponding to the ipfs path will be published every few hours to achieve a state of preservation.

Delete IPNS

Publish IPNS name

Retrieve IPNS Name

If you have any questions, please join our , or send us an email at .

Discord server
contact@4everland.org

Delete IPNS

delete

Request

curl -X "DELETE" "https://api.4everland.dev/ipns/v1/names/example.eth"
-H 'Authorization: $AUTH_TOKEN'

Response

HTTP 200 OK
{
  "code": "SUCCESS",
  "message": "success",
  "data": {}
}
Path parameters
namestringRequired

The IPNS name.

Header parameters
AuthorizationstringRequired

Authorization (Only:)

Responses
200
successful operation
application/json
delete
DELETE /v1/names/{name} HTTP/1.1
Host: ipns
Authorization: text
Accept: */*
200

successful operation

{
  "code": "text",
  "message": "text",
  "data": {}
}
  • Auth Token
  • Create IPNS Name
  • POSTCreate IPNS Name
  • List IPNS Names
  • GETList IPNS Names
  • Delete IPNS
  • DELETEDelete IPNS
  • Publish IPNS name
  • POSTPublish IPNS name
  • Retrieve IPNS Name
  • GETRetrieve IPNS Name

Create IPNS Name

post

Request

curl -X "POST" "https://api.4everland.dev/ipns/v1/names" \
-H 'Authorization: $AUTH_TOKEN' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{
  "name": "example.eth"
}'

Response

HTTP 200 OK
{
    "code":"SUCCESS",
    "message":"success",
    "data":{
        "key":"k51qzi5uqu5dlam30k8825vcss6lc11iytluqb5h1glc2fpqh7pfjs9r18idy6"
    }
}
Header parameters
AuthorizationstringRequired

Authorization (Only:)

Body
namestringRequired

The IPNS name.

Responses
200
successful operation
application/json
post
POST /v1/names HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

successful operation

{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "key": "text"
  }
}

List IPNS Names

get

Request

curl "https://api.4everland.dev/ipns/v1/names?cursor=0" \
     -H 'Authorization: $AUTH_TOKEN'

Response

HTTP 200 OK
{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "list": [
      {
        "name": "example.eth",
        "key": "k51qzi5uqu5dhzjrd6l7s4ba8cspzctm1d96efloxcqkokvgg0f77ied7nc6zz",
        "ipfsPath": "/ipns/k51qzi5uqu5dhzjrd6l7s4ba8cspzctm1d96efloxcqkokvgg0f77ied7nc6zz",
        "createdAt": 1667806756,
        "lifetime": 1
      },
      {
        "name": "example",
        "key": "k51qzi5uqu5dlam30k8825vcss6lc11iytluqb5h1glc2fpqh7pfjs9r18idy6",
        "ipfsPath": "/ipfs/bafybeifx7yeb55armcsxwwitkymga5xf53dxiarykms3ygqic223w5sk3m",
        "createdAt": 1667538738,
        "lifetime": 1
      }
    ],
    "page": {
      "next": "1667538738773825",
      "total": 2,
      "hasNext": false
    }
  }
}
Query parameters
cursorstringOptional

First page default 0.

Header parameters
AuthorizationstringRequired

Authorization (Only:)

Body
namestringRequired

The IPNS name.

Responses
200
successful operation
application/json
get
GET /v1/names HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

successful operation

{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "list": [
      {
        "name": "text",
        "key": "text",
        "ipfsPath": "text",
        "createdAt": 1,
        "lifetime": 1
      }
    ],
    "page": {
      "next": "text",
      "total": 1,
      "hasNext": true
    }
  }
}

Publish IPNS name

post

Request

curl -X "POST" "https://api.4everland.dev/ipns/v1/names/example.eth"
-H 'Authorization: $AUTH_TOKEN'
-H 'Content-Type: application/json; charset=utf-8'
-d $'{
  "ipfsPath": "/ipfs/bafybeihrmwcuv7z4vqhp7grzy52qnwwhwulslkdnetlaegohm2ibawtlni",
  "lifetime": 1
}'

Response

HTTP 200 OK
{
  "code": "SUCCESS",
  "message": "success",
  "data": {}
}
Path parameters
namestringRequired

The IPNS name.

Header parameters
AuthorizationstringRequired

Authorization (Only:)

Body
ipfsPpathstringRequired

IPNS publish value. example: https://docs.ipfs.tech/concepts/ipns/#how-ipns-names-relate-to-content-paths

lifetimenumberOptional

The default value is 1 day, and the maximum is 365 days. If it is 0, it is based on the configuration of the last lifetime.

Default: 1
Responses
200
successful operation
application/json
post
POST /v1/names/{name} HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "ipfsPpath": "text",
  "lifetime": "1"
}
200

successful operation

{
  "code": "text",
  "message": "text",
  "data": {}
}

Retrieve IPNS Name

get

Request

curl "https://api.4everland.dev/ipns/v1/names/example.eth" \
     -H 'Authorization: $AUTH_TOKEN'

Response

HTTP 200 OK
{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "name": "example.eth",
    "key": "k51qzi5uqu5dhzjrd6l7s4ba8cspzctm1d96efloxcqkokvgg0f77ied7nc6zz",
    "ipfsPath": "/ipns/k51qzi5uqu5dlam30k8825vcss6lc11iytluqb5h1glc2fpqh7pfjs9r18idy6",
    "createdAt": 1667806756,
    "lifetime": 1
  }
}
Path parameters
namestringRequired

IPNS name.

Header parameters
AuthorizationstringRequired

Authorization (Only:)

Body
namestringRequired

The IPNS name.

Responses
200
successful operation
application/json
get
GET /v1/names/{name} HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

successful operation

{
  "code": "text",
  "message": "text",
  "data": {
    "name": "text",
    "key": "text",
    "ipfsPath": "text",
    "createdAt": 1,
    "lifetime": 1
  }
}