Bee Debug API (0.5.1)

Download OpenAPI specification:Download

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

Connectivity

Get overlay and underlay addresses of the node

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "overlay": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "underlay":
    [
    ],
  • "ethereum": "36b7efd913ca4cf880b8eeac5093fa27b0825906",
  • "public_key": "02ab7473879005929d10ce7d4f626412dad9fe56b0a6622038931d26bd79abf0a4",
  • "pss_public_key": "02ab7473879005929d10ce7d4f626412dad9fe56b0a6622038931d26bd79abf0a4"
}

Get a list of blocklisted peers

Authorizations:

Responses

Response samples

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

Connect to address

Authorizations:
path Parameters
multiAddress
required
string

Underlay address of peer

Responses

Response samples

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

Get a list of peers

Authorizations:

Responses

Response samples

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

Remove peer

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

Swarm address of peer

Responses

Response samples

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

Try connection to node

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

Swarm address of peer

Responses

Response samples

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

Get topology of known network

Get topology of known network

Authorizations:

Responses

Response samples

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

Get configured P2P welcome message

Authorizations:

Responses

Response samples

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

Set P2P welcome message

Authorizations:
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"
}

Balance

Get the balances with all known peers including prepaid services

Authorizations:

Responses

Response samples

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

Get the balances with a specific peer including prepaid services

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "balance": 0
}

Get the past due consumption balances with all known peers

Authorizations:

Responses

Response samples

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

Get the past due consumption balance with a specific peer

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "balance": 0
}

Chequebook

Get the address of the chequebook contract used

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "chequebookaddress": "36b7efd913ca4cf880b8eeac5093fa27b0825906"
}

Get the balance of the chequebook

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "totalBalance": 0,
  • "availableBalance": 0
}

Get last cashout action for the peer

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "chequebook": "36b7efd913ca4cf880b8eeac5093fa27b0825906",
  • "cumulativePayout": 0,
  • "beneficiary": "36b7efd913ca4cf880b8eeac5093fa27b0825906",
  • "transactionHash": "e28a34ffe7b1710c1baf97ca6d71d81b7f159a9920910876856c8d94dd7be4ae",
  • "result":
    {
    }
}

Cashout the last cheque for the peer

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "e28a34ffe7b1710c1baf97ca6d71d81b7f159a9920910876856c8d94dd7be4ae"
}

Get last cheques for the peer

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "lastreceived":
    {
    },
  • "lastsent":
    {
    }
}

Get last cheques for all peers

Authorizations:

Responses

Response samples

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

Deposit tokens from overlay address into chequebook

Authorizations:
query Parameters
amount
required
integer

amount of tokens to deposit

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "e28a34ffe7b1710c1baf97ca6d71d81b7f159a9920910876856c8d94dd7be4ae"
}

Withdraw tokens from the chequebook to the overlay address

Authorizations:
query Parameters
amount
required
integer

amount of tokens to withdraw

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "e28a34ffe7b1710c1baf97ca6d71d81b7f159a9920910876856c8d94dd7be4ae"
}

Chunk

Check if chunk at address exists locally

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

Swarm address of chunk

Responses

Response samples

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

Delete a chunk from local storage

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

Swarm address of chunk

Responses

Response samples

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

Status

Get health of node

Authorizations:

Responses

Response samples

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

Get readiness state of node

Authorizations:

Responses

Response samples

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

Settlements

Get amount of sent and received from settlements with a peer

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "received": 0,
  • "sent": 0
}

Get settlements with all known peers and total amount sent or received

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "totalreceived": 0,
  • "totalsent": 0,
  • "settlements":
    [
    ]
}

Tag

Get Tag information using Uid

Authorizations:
path Parameters
uid
required
integer

Uid

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "split": 0,
  • "seen": 0,
  • "stored": 0,
  • "sent": 0,
  • "synced": 0,
  • "uid": 0,
  • "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "startedAt": "2020-06-11T11:26:42.6969797+02:00"
}