Updated on 2023-08-08 GMT+08:00

API Overview

You can use the APIs provided by NES to create nodes, create keys, and query a node. Table 1 lists the APIs. For details about APIs, see API.

Table 1 API overview

Type

API

Description

NES

Deleting an API key

This API is used to delete an API key.

Obtaining all API keys of a user

This API is used to obtain all API keys of a specified user.

Creating an API key

This API is used to create an API key and return the API key file.

Obtaining the network types

This API is used to obtain the network types.

Obtaining all specifications

This API is used to obtain all specifications.

Obtaining all nodes on a specified network

This API is used to obtain all nodes on a specified network.

Creating nodes

This API is used to create nodes based on the specifications.

Obtaining node alarms

This API is used to generate alarms according to the built-in alarm rules.

Obtaining the API calling information of a node in a specified period

This API is used to obtain the API calling information of a node in a specified period.

Obtaining available specifications for node scaling

This API is used to obtain available specifications for node scaling.

Obtaining the node monitoring information

This API is used to obtain the node information, including the CPU usage, memory usage, uplink/downlink network traffic, storage, and disk read/write.

Deleting a node

This API is used to delete a node.

Querying a node

This API is used to query a node.

Changing the node specifications

This API is used to change the node specifications.

Obtaining the overview information

This API is used to obtain the overview information of the current user.

Obtaining the status of a staking node in a specified period

This API is used to obtain the status of a staking node in a specified period, including its synchronization status, peer, and block height.

Downloading the certificates

This API is used to download the certificates.