IPNS Manager API

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

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

Create IPNS Name

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"
    }
}

POST//ipns/v1/names

Header parameters

Body

application/json

name*string

The IPNS name.

Response

200

successful operation

Body

*/*

code*string

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('//ipns/v1/names', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

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

List IPNS Names

List IPNS Names

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
    }
  }
}

GET//ipns/v1/names

Query parameters

Header parameters

Body

application/json

name*string

The IPNS name.

Response

200

successful operation

Body

*/*

code*string

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('//ipns/v1/names', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

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

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

Delete IPNS

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": {}
}

DELETE//ipns/v1/names/{name}

Path parameters

name*string

The IPNS name.

Header parameters

Response

200

successful operation

Body

*/*

code*string

message*string

dataobject

Request

JavaScriptCurl

const response = await fetch('//ipns/v1/names/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

Publish IPNS name

Publish IPNS name

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": {}
}

POST//ipns/v1/names/{name}

Path parameters

name*string

The IPNS name.

Header parameters

Body

application/json

ipfsPpath*string

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

lifetimenumber

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.

Response

200

successful operation

Body

*/*

code*string

message*string

dataobject

Request

JavaScriptCurl

const response = await fetch('//ipns/v1/names/{name}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ipfsPpath": "text"
    }),
});
const data = await response.json();

Response

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

Retrieve IPNS Name

Retrieve IPNS Name

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
  }
}

GET//ipns/v1/names/{name}

Path parameters

name*string

IPNS name.

Header parameters

Body

application/json

name*string

The IPNS name.

Response

200

successful operation

Body

*/*

code*string

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('//ipns/v1/names/{name}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

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

If you have any questions, please join our Discord server, or send us an email at [e-mail].