favorX Debug API (1.2.2)

Download OpenAPI specification:Download

A list of the currently provided debug interfaces to interact with the favorX node

Status

Get readiness state of node

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "version": "string",
  • "fullNode": true,
  • "bootNodeMode": true,
  • "auth": true
}

Get health of node

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "version": "string",
  • "fullNode": true,
  • "bootNodeMode": true,
  • "auth": true
}

Connectivity

Get overlay and underlay addresses of the node

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "overlay": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "underlay": [
    ],
  • "nat_route": [
    ],
  • "public_ip": {
    },
  • "network_id": 0,
  • "public_key": "02ab7473879005929d10ce7d4f626412dad9fe56b0a6622038931d26bd79abf0a4"
}

Try connection to node

Authorizations:
None
path Parameters
peer-id
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

Responses

Response samples

Content type
application/json
{
  • "rtt": "5.0018ms"
}

Connect to address

Authorizations:
None
path Parameters
multiAddress
required
string (MultiAddress)

Underlay address of peer

Responses

Response samples

Content type
application/json
{
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}

Get a list of block peers

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "peers": [
    ]
}

add peer to block list

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

query Parameters
timeout
required
string

A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix,such as '300ms', '2h45m'. Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Remove peer from block list

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get a list of peers

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "peers": [
    ]
}

Remove peer

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get topology of known network

Get topology of known network

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "baseAddr": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "population": 0,
  • "connected": 0,
  • "timestamp": "string",
  • "nnLowWatermark": 0,
  • "depth": 0,
  • "reachability": "Unknown",
  • "networkAvailability": "Unknown",
  • "bins": {
    },
  • "lightNodes": {
    },
  • "bootNodes": {
    }
}

Get topology of known groups

Get topology of known groups

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "connected": 0,
  • "timestamp": "2020-06-11T11:26:42.6969797+02:00",
  • "groups": [
    ]
}

Get configured P2P welcome message

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "welcome_message": "string"
}

Set P2P welcome message

Authorizations:
None
Request Body schema: application/json
welcome_message
string

Responses

Request samples

Content type
application/json
{
  • "welcome_message": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

Routetab

Get route from node

Authorizations:
None
path Parameters
peer-id
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

Responses

Response samples

Content type
application/json
{
  • "paths": [
    ]
}

Doing findroute to node

Authorizations:
None
path Parameters
peer-id
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

Responses

Response samples

Content type
application/json
{
  • "paths": [
    ]
}

Delete route to node

Authorizations:
None
path Parameters
peer-id
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of peer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Chunk

Check if chunk at address exists locally

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of chunk

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Delete a chunk from local storage

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of chunk

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Get chunk discovery nodes

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of chunk

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get chunk server nodes

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of chunk

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get chunk pyramid

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of chunk

Responses

Response samples

Content type
application/json
{
  • "msg": true
}

Get chunk source

Authorizations:
None
path Parameters
address
required
string (BosonAddress) ^[A-Fa-f0-9]{64}$
Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f

Boson address of chunk

Responses

Response samples

Content type
application/json
{
  • "pyramidSource": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "fileChunkCount": 2,
  • "chunkSource": [
    ]
}

metrics

Prometheus metrics gateway

Authorizations:
None

Responses

pprof

Responds with the running program's command line, with arguments separated by NUL bytes

Authorizations:
None

Responses

Responds with the pprof-formatted cpu profile

Authorizations:
None
query Parameters
seconds
integer

profiling lasts for duration specified in seconds GET parameter, or for 30 seconds if not specified.

Responses

Looks up the program counters listed in the request, responding with a table mapping program counters to function names

Authorizations:
None
Request Body schema: text/plain
string

Responses

Responds with the execution trace in binary form

Authorizations:
None
query Parameters
seconds
integer

tracing lasts for duration specified in seconds GET parameter, or for 1 second if not specified.

Responses

Responds with the pprof-formatted profile named by the request

Authorizations:
None

Responses

Exposes os.Args and runtime.Memstats information

Authorizations:
None

Responses

Response samples

Content type
application/json
"string"

Traffic

Initialize traffic information

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": 0
}

Account

Get account keystore json or private key

Authorizations:
None
Request Body schema: application/json
password
string

The password for this private key

type
string

If the type is equal to private, export the private key, otherwise export the keystore json

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "type": "string"
}

Response samples

Content type
application/json
Example
{
  • "address": "2f8b6f42b70a1ed0bf4f9100f88b8e9e3aecfafd",
  • "crypto": {
    },
  • "id": "4480f8d3-80ec-4dff-bbff-0390e1fbd83c",
  • "version": 3
}