#Getting Started

The Manager API allows you to gather common node information, access logs, control running processes and handle ledger snapshots on demand. Requests should contain valid JSON RPC 2.0 data which are transformed over HTTP / HTTPS protocol using GET method.

#Alias

manager

#Installation

The Manager API is official ARK Ecosystem plugin, but it does not come with the default installation. You can install plugin manually by running:

1ark plugin:install @arkecosystem/core-manager

Check if plugin is installed successfully, by using following command:

1ark help

You should see manager section under available commands.

#Configuration

The Manager API is not configured by default and you should configure it manually by customizing settings in app.json and .env file. To simplify this process you can perform basic configuration through the interactive process.

1ark manager:config

Additionally, you can customize API specific settings in .env or app.json file.

#Argon2Id Basic Authentication

It is recommended to make configuration changes for defining user access and IP whitelisting within your app.json file.

 1{
 2    "package": "@arkecosystem/core-manager",
 3    "options": {
 4        "plugins": {
 5            "whitelist": ["127.0.0.1"],
 6            "basicAuthentication": {
 7                "enabled": true,
 8                "secret": "secret",
 9                "users": [
10                    {
11                        "username": "username",
12                        "password": "$argon2id$v=19$m=4096,t=3,p=1$NiGA5Cy5vFWTxhBaZMG/3Q$TwEFlzTuIB0fDy+qozEas+GzEiBcLRkm5F+/ClVRCDY"
13                    }
14                ]
15            }
16        }
17    }
18}

The whitelist property is an Array consisting of IP addresses that you allow to make connections to the manager API. By default, only local access to the webhook API is allowed. This means that if you want to expose your webhook API to the outside, you’ll need to explicitly add the IP addresses that you will use to this list (recommended approach). It is also possible to use wildcards to indicate a range of IPs (e.g. "12.34.56.*") or even to allow everyone (e.g. "*") (not recommended).

#Token authentication

Alternatively, instead of using basic authentication, token authentication can be enabled (not recommend).

 1{
 2    "package": "@arkecosystem/core-manager",
 3    "options": {
 4        "plugins": {
 5            "whitelist": ["127.0.0.1"],
 6            "tokenAuthentication": {
 7                "enabled": true,
 8                "token": "secret_token"
 9            }
10        }
11    }
12}

Include Authorization header into request with content: Bearer <secret_token>.

#Network related environment variables

It is recommended to make configuration changes to these options by working with your .env file and the corresponding variables:

#Requirements

Manager API obtains some of the required data from running either a core or relay & forger process.

#Store events and logs

When package is used on core or relay & forger processes it can provide additional functionality for storing logs and events in a local sqlite database. Stored data can be queried from dedicated JsonRPC calls. Additionally logs can be achieved and downloaded using customized filtering. This functionality is enabled only when package is added into app.json settings file in desired process plugins.

 1"core": {
 2    "plugins": [
 3        {
 4            "package": "@arkecosystem/core-logger-pino"
 5        },
 6        {
 7            "package": "@arkecosystem/core-manager"
 8        },
 9        {
10            "package": "@arkecosystem/core-state"
11        },
12        ...
13    ]
14},

#Options

Core manager offers variety of options from filtering stored event types, enabling and disabling logs and event storing to defining length of logs history in days. Options can be set via ENV variables or under package options in app.json file.

#Watcher related environment variables

It is recommended to make configuration changes to these options by working with your .env file and the corresponding variables:

#Final checks

After making changes to the manager API configuration, you will need to restart your manager process for the changes to take effect. If you want to check whether your manager API is running, you should pay attention to the startup messages in the logs of your relay. It will print a line similar to INFO : Public JSON-RPC API (HTTP) Server started at http://0.0.0.0:4005 when it has successfully started the manager API.

#Security

If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.