Skip to main content
API docs by Redocly

Bee Debug API (4.1.1)

Download OpenAPI specification:Download

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

Browse the documentation @ the Swarm Docs

Connectivity

Get overlay and underlay addresses of the node

Authorizations:
None

Responses

Response samples

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

Get a list of blocklisted peers

Authorizations:
None

Responses

Response samples

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

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 peers

Authorizations:
None

Responses

Response samples

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

Remove peer

Authorizations:
None
path Parameters
address
required
string (SwarmAddress) ^[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:
None
path Parameters
address
required
string (SwarmAddress) ^[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:
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": {
    }
}

Get configured P2P welcome message

Authorizations:
None

Responses

Response samples

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

Set P2P welcome message

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "ok",
  • "version": "string",
  • "apiVersion": "0.0.0",
  • "debugApiVersion": "0.0.0"
}

Balance

Get all accounting associated values with all known peers

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "peerData": {
    }
}

Get the balances with all known peers including prepaid services

Authorizations:
None

Responses

Response samples

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

Get the balances with a specific peer including prepaid services

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

Swarm address of peer

Responses

Response samples

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

Get the past due consumption balances with all known peers

Authorizations:
None

Responses

Response samples

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

Get the past due consumption balance with a specific peer

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

Swarm address of peer

Responses

Response samples

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

Chequebook

Get the address of the chequebook contract used

Authorizations:
None

Responses

Response samples

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

Get the balance of the chequebook

Authorizations:
None

Responses

Response samples

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

Get last cashout action for the peer

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

Swarm address of peer

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "lastCashedCheque": {
    },
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a",
  • "result": {
    },
  • "uncashedAmount": "1000000000000000000"
}

Cashout the last cheque for the peer

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

Swarm address of peer

header Parameters
gas-price
integer (GasPrice)

Gas price for transaction

gas-limit
integer (GasLimit) [ 0 .. 18446744073709552000 ]

Gas limit for transaction

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Get last cheques for the peer

Authorizations:
None
path Parameters
peer-id
required
string (SwarmAddress) ^[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:
None

Responses

Response samples

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

Deposit tokens from overlay address into chequebook

Authorizations:
None
query Parameters
amount
required
integer

amount of tokens to deposit

header Parameters
gas-price
integer (GasPrice)

Gas price for transaction

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Withdraw tokens from the chequebook to the overlay address

Authorizations:
None
query Parameters
amount
required
integer

amount of tokens to withdraw

header Parameters
gas-price
integer (GasPrice)

Gas price for transaction

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Chunk

Check if chunk at address exists locally

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

Swarm address of chunk

Responses

Response samples

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

Status

Get reserve state

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "radius": 0,
  • "storageRadius": 0,
  • "commitment": 0
}

Get chain state

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "chainTip": 0,
  • "block": 0,
  • "totalAmount": "1000000000000000000",
  • "currentPrice": "1000000000000000000"
}

Get information about the node

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "beeMode": "light",
  • "chequebookEnabled": true,
  • "swapEnabled": true
}

Get node overall health Status

Health Status will indicate node healthiness.

If node is unhealthy please check node logs for errors.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "version": "string",
  • "apiVersion": "0.0.0",
  • "debugApiVersion": "0.0.0"
}

Readiness endpoint indicates if node is ready to start accepting traffic

Authorizations:
None

Responses

Response samples

Content type
application/problem+json
{
  • "code": 0,
  • "message": "string",
  • "reasons": [
    ]
}

Settlements

Get amount of sent and received from settlements with a peer

Authorizations:
None
path Parameters
address
required
string (SwarmAddress) ^[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:
None

Responses

Response samples

Content type
application/json
{
  • "totalReceived": 0,
  • "totalSent": 0,
  • "settlements": [
    ]
}

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

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "totalReceived": 0,
  • "totalSent": 0,
  • "settlements": [
    ]
}

RedistributionState

Get current status of node in redistribution game

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "minimumGasFunds": "1000000000000000000",
  • "hasSufficientFunds": true,
  • "isFrozen": true,
  • "isFullySynced": true,
  • "isHealthy": true,
  • "phase": "string",
  • "round": 0,
  • "lastWonRound": 0,
  • "lastPlayedRound": 0,
  • "lastFrozenRound": 0,
  • "lastSelectedRound": 0,
  • "lastSampleDuration": "5.0018ms",
  • "block": 0,
  • "reward": "1000000000000000000",
  • "fees": "1000000000000000000"
}

Wallet

Get wallet balance for BZZ and xDAI

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "bzzBalance": "1000000000000000000",
  • "nativeTokenBalance": "1000000000000000000",
  • "chainID": 0,
  • "chequebookContractAddress": "36b7efd913ca4cf880b8eeac5093fa27b0825906",
  • "walletAddress": "36b7efd913ca4cf880b8eeac5093fa27b0825906"
}

Allows withdrawals of BZZ or xDAI to provided (whitelisted) address

Authorizations:
None
path Parameters
coin
required
string

Token to withdraw, accepted values include BZZ and NativeToken (for xDAI).

query Parameters
amount
required
string (BigInt)
Example: amount=1000000000000000000

Integer amount to withdraw specified in lowest denomination for each respective token (wei for xDAI and PLUR for BZZ).

address
required
string (EthereumAddress) ^[A-Fa-f0-9]{40}$
Example: address=36b7efd913ca4cf880b8eeac5093fa27b0825906

Target Gnosis Chain address for withdrawal. Address must be whitelisted in node configuration through the withdrawal-addresses-whitelist option.

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Transaction

Get list of pending transactions

Authorizations:
None

Responses

Response samples

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

Get information about a sent transaction

Authorizations:
None
path Parameters
txHash
required
string (TransactionHash) ^0x[A-Fa-f0-9]{64}$
Example: 0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a

Hash of the transaction

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a",
  • "to": "36b7efd913ca4cf880b8eeac5093fa27b0825906",
  • "nonce": 0,
  • "gasPrice": "1000000000000000000",
  • "gasLimit": 0,
  • "gasTipCap": "1000000000000000000",
  • "gasTipBoost": 0,
  • "gasFeeCap": "1000000000000000000",
  • "data": "string",
  • "created": "2020-06-11T11:26:42.6969797+02:00",
  • "description": "string",
  • "value": "1000000000000000000"
}

Rebroadcast existing transaction

Authorizations:
None
path Parameters
txHash
required
string (TransactionHash) ^0x[A-Fa-f0-9]{64}$
Example: 0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a

Hash of the transaction

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Cancel existing transaction

Authorizations:
None
path Parameters
txHash
required
string (TransactionHash) ^0x[A-Fa-f0-9]{64}$
Example: 0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a

Hash of the transaction

header Parameters
gas-price
integer (GasPrice)

Gas price for transaction

Responses

Response samples

Content type
application/json
{
  • "transactionHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Postage Stamps

Get stamps for this node

Authorizations:
None

Responses

Response samples

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

Get an individual postage batch status

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

Swarm address of the stamp

Responses

Response samples

Content type
application/json
Example
{
  • "batchID": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "utilization": 0,
  • "usable": true,
  • "label": "string",
  • "depth": 0,
  • "amount": "1000000000000000000",
  • "bucketDepth": 0,
  • "blockNumber": 0,
  • "immutableFlag": true,
  • "exists": true,
  • "batchTTL": 0
}

Get extended bucket data of a batch

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

Swarm address of the stamp

Responses

Response samples

Content type
application/json
{
  • "depth": 0,
  • "bucketDepth": 0,
  • "bucketUpperBound": 0,
  • "buckets": [
    ]
}

Buy a new postage batch.

Be aware, this endpoint creates an on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance!

Authorizations:
None
path Parameters
amount
required
string (BigInt)
Example: 1000000000000000000

Amount of BZZ added that the postage batch will have.

depth
required
integer

Batch depth which specifies how many chunks can be signed with the batch. It is a logarithm. Must be higher than default bucket depth (16)

query Parameters
label
string

An optional label for this batch

header Parameters
immutable
boolean

Responses

Response samples

Content type
application/json
{
  • "batchID": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "txHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Top up an existing postage batch.

Be aware, this endpoint creates on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance!

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

Batch ID to top up

amount
required
integer

Amount of BZZ per chunk to top up to an existing postage batch.

Responses

Response samples

Content type
application/json
{
  • "batchID": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "txHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Dilute an existing postage batch.

Be aware, this endpoint creates on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance!

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

Batch ID to dilute

depth
required
integer

New batch depth. Must be higher than the previous depth.

Responses

Response samples

Content type
application/json
{
  • "batchID": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "txHash": "0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"
}

Get all globally available batches that were purchased by all nodes.

Authorizations:
None

Responses

Response samples

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

Staking

Deposit some amount for staking.

Be aware, this endpoint creates an on-chain transactions and transfers BZZ from the node's Ethereum account and hence directly manipulates the wallet balance.

Authorizations:
None
path Parameters
amount
string

Amount of BZZ added that will be deposited for staking.

header Parameters
gas-price
integer (GasPrice)

Gas price for transaction

gas-limit
integer (GasLimit) [ 0 .. 18446744073709552000 ]

Gas limit for transaction

Responses

Response samples

Content type
application/problem+json
{
  • "code": 0,
  • "message": "string",
  • "reasons": [
    ]
}

Get the staked amount.

This endpoint fetches the staked amount from the blockchain.

Authorizations:
None

Responses

Response samples

Content type
application/problem+json
{
  • "code": 0,
  • "message": "string",
  • "reasons": [
    ]
}

Logging

Get all available loggers.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "tree": {
    },
  • "loggers": [
    ]
}

Get all available loggers that match the specified expression.

Authorizations:
None
path Parameters
exp
required
string (LoggerExp) ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...
Example: b25lL25hbWU=

Regular expression or a subsystem that matches the logger(s).

Responses

Response samples

Content type
application/json
{
  • "tree": {
    },
  • "loggers": [
    ]
}

Set logger(s) verbosity level.

Authorizations:
None
path Parameters
exp
required
string (LoggerExp) ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...
Example: b25lL25hbWU=

Regular expression or a subsystem that matches the logger(s).

Responses

Response samples

Content type
application/problem+json
{
  • "code": 0,
  • "message": "string",
  • "reasons": [
    ]
}

Node Status

Get the current status snapshot of this node.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  • "beeMode": "light",
  • "proximity": 0,
  • "reserveSize": 0,
  • "reserveSizeWithinRadius": null,
  • "pullsyncRate": 0,
  • "storageRadius": 0,
  • "connectedPeers": 0,
  • "neighborhoodSize": 0,
  • "requestFailed": true,
  • "BatchCommitment": 0,
  • "isReachable": true
}

Get the current status snapshot of this node connected peers.

Authorizations:
None

Responses

Response samples

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