IPNS Deployment Update API

This API is used to update projects that have been deployed by IPNS.

Usage Scenarios

Obtaining user permissions

API calls require the passing of an Auth Token. It is used to control all the Hosting projects under the account.

Once created, the token will only be displayed once. Please keep it safe. You can create a new one if you lose it.

List

No.	APIs	Description	Date
1	IPNS resolve	Update deploy	2023/03/01
2	Get IPNS resolve status	Get IPNS resolve Name and Status	2023/03/01

IPNS resolve API

Description

1. Request Method: POST

2. Request Address: https://api.4everland.org

3. Path: /api/ipns/resolve

Request parameter

Headers:

Name	Value	Required	Note
Content-Type	application/x-www-form-urlencoded	True
Token		Ture	Auth Token

Query

Name	Required	Note
projectName	True	IPNS Project Name

• Request Case: https://api.4everland.org/api/ipns/resolve?projectName=testProject

• Limit flow based on user, one second to initiate one successful request

Return data

Name	Type	Required	Note
code	number	False	Return Code
message	string	False
data	object	False

Response

{
  "code": 200,
  "message": "success",
  "data": {}
}

Error

10025: Access is denied!
10009 :  Project is not exist!
100072 : This is not an IPNS project!
100073 :  Request limit: 1 request per second!

Get IPNS resolve status API

Description

1. Request Method: GET

2. Request Address: https://api.4everland.org

3. Path: /api/ipns/resolve/status

Request parameter

Headers:

Name	Required	Case	Note
token	True		Auth Token

Query

Name	Required	Note
projectName	True	IPNS Project Name

Request Case: https://api.4everland.org/api/ipns/resolve/status?projectName=testProject

Return data

Name	Type	Required	Note
code	number	False	Return Code
message	string	False
data	object	False
ipnsResolve	string	False	Latest cid
status	string	False	Last deployment status
updateAt	string	False	Time(UTC+0)

Response

{
    "code": 200,
    "message": "success",
    "data": {
        "ipnsResolve": "bafybeifjojp4mri2k775lsv3tgf5r2lg5jtxcdfufop52ygkwmqxjakl3m",
        "status": "SUCCESS",
        "updateAt": "2023-03-01 07:12:32"
    }
}

Error

10025: Access is denied!
10009 :  Project is not exist!
100072 : This is not an IPNS project!

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