IPNS Manager API
4EVERLAND IPNS API can help with IPNS creation, retrieval, CID preservation and publishing, etc.
Last updated
4EVERLAND IPNS API can help with IPNS creation, retrieval, CID preservation and publishing, etc.
Last updated
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".
curl -X "DELETE" "https://api.4everland.dev/ipns/v1/names/example.eth"
-H 'Authorization: $AUTH_TOKEN'
HTTP 200 OK
{
"code": "SUCCESS",
"message": "success",
"data": {}
}
The IPNS name.
Authorization (Only:)
DELETE /v1/names/{name} HTTP/1.1
Host: ipns
Authorization: text
Accept: */*
successful operation
{
"code": "text",
"message": "text",
"data": {}
}
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"
}'
HTTP 200 OK
{
"code":"SUCCESS",
"message":"success",
"data":{
"key":"k51qzi5uqu5dlam30k8825vcss6lc11iytluqb5h1glc2fpqh7pfjs9r18idy6"
}
}
Authorization (Only:)
The IPNS name.
POST /v1/names HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}
successful operation
{
"code": "SUCCESS",
"message": "success",
"data": {
"key": "text"
}
}
curl "https://api.4everland.dev/ipns/v1/names?cursor=0" \
-H 'Authorization: $AUTH_TOKEN'
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
}
}
}
First page default 0.
Authorization (Only:)
The IPNS name.
GET /v1/names HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}
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
}
}
}
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
}'
HTTP 200 OK
{
"code": "SUCCESS",
"message": "success",
"data": {}
}
The IPNS name.
Authorization (Only:)
IPNS publish value. example: https://docs.ipfs.tech/concepts/ipns/#how-ipns-names-relate-to-content-paths
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.
1
POST /v1/names/{name} HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"ipfsPpath": "text",
"lifetime": "1"
}
successful operation
{
"code": "text",
"message": "text",
"data": {}
}
curl "https://api.4everland.dev/ipns/v1/names/example.eth" \
-H 'Authorization: $AUTH_TOKEN'
HTTP 200 OK
{
"code": "SUCCESS",
"message": "success",
"data": {
"name": "example.eth",
"key": "k51qzi5uqu5dhzjrd6l7s4ba8cspzctm1d96efloxcqkokvgg0f77ied7nc6zz",
"ipfsPath": "/ipns/k51qzi5uqu5dlam30k8825vcss6lc11iytluqb5h1glc2fpqh7pfjs9r18idy6",
"createdAt": 1667806756,
"lifetime": 1
}
}
IPNS name.
Authorization (Only:)
The IPNS name.
GET /v1/names/{name} HTTP/1.1
Host: ipns
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}
successful operation
{
"code": "text",
"message": "text",
"data": {
"name": "text",
"key": "text",
"ipfsPath": "text",
"createdAt": 1,
"lifetime": 1
}
}