Links

Admin API

This API can be used for measuring node health and debugging. Note that the Admin API is disabled by default for security reasons.
To run a node with the Admin API enabled, use command line argument --api-admin-enabled=true.

Path

/ext/admin

API Methods

admin.alias

Assign an alias to an API endpoint, basically a different endpoint for the API. The original endpoint will still work. This change only affects this node; other nodes will not know about this alias.
  • endpoint is the original endpoint of the API. endpoint should only include the part of the endpoint after /ext/.
  • The API being aliased can now be called at ext/alias.
  • alias can be at most 512 characters.

Example Call

//Request
curl -X POST --data '{
"jsonrpc":"2.0",
"id" :1,
"method" :"admin.alias",
"params": {
"alias":"testAlias",
"endpoint":"bc/X"
}
}' -H 'content-type:application/json;' https://ava-api.bwarelabs.com/<your-endpoint-id>/ext/admin
//Response
{
"jsonrpc":"2.0",
"id" :1,
"result" :{
"success":true
}
}
Last modified 1yr ago