Admin API

Search…

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
1
/ext/admin
Copied!
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
1
//Request
2
curl -X POST --data '{
3
    "jsonrpc":"2.0",
4
    "id"     :1,
5
    "method" :"admin.alias",
6
    "params": {
7
        "alias":"testAlias",
8
        "endpoint":"bc/X"
9
    }
10
}' -H 'content-type:application/json;' https://ava-api.bwarelabs.com/<your-endpoint-id>/ext/admin
11
​
12
//Response
13
{
14
    "jsonrpc":"2.0",
15
    "id"     :1,
16
    "result" :{
17
        "success":true
18
    }
19
}
Copied!

Health API

Info API

Last modified 4mo ago

Copy link

Contents

Path

API Methods

Example Call