Config

Config

get

Return the runtime node configuration (this takes into account the command-line arguments and the on-disk configuration file)

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

data-dirone ofOptional

Location of the data dir on disk.

stringOptional

or

disable-config-validationbooleanOptional

Disable the node configuration validation.

internal-eventsone ofOptional

Configuration of the structured logging framework

or

networkone ofOptional

Configuration of which network/blockchain to connect to

string · enumOptionalPossible values:

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/config

HTTPcURLJavaScriptPython

GET /config HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "data-dir": "text",
  "disable-config-validation": true,
  "rpc": {
    "listen-addrs": [
      "text"
    ],
    "listen-addr": "text",
    "cors-origin": [
      "text"
    ],
    "cors-headers": [
      "text"
    ],
    "crt": "text",
    "key": "text",
    "acl": [
      {
        "address": "text",
        "whitelist": [
          "text"
        ]
      }
    ],
    "media-type": "json"
  },
  "p2p": {
    "expected-proof-of-work": 1,
    "bootstrap-peers": [
      "text"
    ],
    "listen-addr": "text",
    "advertised-net-port": 1,
    "discovery-addr": "text",
    "private-mode": true,
    "limits": {
      "connection-timeout": 1,
      "authentication-timeout": 1,
      "min-connections": 1,
      "expected-connections": 1,
      "max-connections": 1,
      "backlog": 1,
      "max-incoming-connections": 1,
      "max-download-speed": 1,
      "max-upload-speed": 1,
      "swap-linger": 1,
      "binary-chunks-size": 1,
      "read-buffer-size": 1,
      "read-queue-size": 1,
      "write-queue-size": 1,
      "incoming-app-message-queue-size": 1,
      "incoming-message-queue-size": 1,
      "outgoing-message-queue-size": 1,
      "max_known_points": [
        1
      ],
      "max_known_peer_ids": [
        1
      ],
      "peer_greylist_size": 1,
      "ip_greylist_size_in_kilobytes": 1,
      "ip_greylist_cleanup_delay": 1,
      "greylist-timeout": 1,
      "maintenance-idle-time": 1
    },
    "disable_mempool": true,
    "enable_testchain": true,
    "greylisting_config": {
      "factor": 1,
      "initial-delay": 1,
      "disconnection-delay": 1,
      "increase-cap": 1
    },
    "disable_peer_discovery": true
  },
  "log": {
    "output": "text",
    "level": "info",
    "colors": true,
    "rules": "text"
  },
  "internal-events": {
    "active_sinks": [
      "text"
    ]
  },
  "shell": {
    "peer_validator": {
      "block_header_request_timeout": 1,
      "block_operations_request_timeout": 1,
      "protocol_request_timeout": 1,
      "new_head_request_timeout": 1
    },
    "block_validator": {
      "protocol_request_timeout": 1,
      "operation_metadata_size_limit": "unlimited"
    },
    "prevalidator": {
      "operations_request_timeout": 1,
      "max_refused_operations": 1,
      "operations_batch_size": 1
    },
    "chain_validator": {
      "latency": 1,
      "synchronisation_threshold": 1
    },
    "history_mode": "archive"
  },
  "network": "sandbox",
  "metrics_addr": [
    "text"
  ]
}

History mode

get

Returns the history mode of the node's underlying storage.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

history_modeone ofRequired

Storage mode for the Tezos shell.

string · enumOptional

Archive mode retains every block and operations since the genesis block including their metadata and their associated contexts.

Possible values:

or

or

or

string · enumOptional

Full mode with default number of additional cycles.

Possible values:

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/config/history_mode

HTTPcURLJavaScriptPython

GET /config/history_mode HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "history_mode": "archive"
}

Config network dal

get

Configuration for the DAL

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

activatedbooleanRequired

use_mock_srs_for_testingbooleanRequired

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/config/network/dal

HTTPcURLJavaScriptPython

GET /config/network/dal HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "activated": true,
  "use_mock_srs_for_testing": true,
  "bootstrap_peers": [
    "text"
  ]
}

User activated protocol overrides

get

List of protocols which replace other protocols

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

User activated protocol overrides: activate a protocol instead of another.

replaced_protocolone ofRequired

stringOptional

or

replacement_protocolone ofRequired

stringOptional

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/config/network/user_activated_protocol_overrides

HTTPcURLJavaScriptPython

GET /config/network/user_activated_protocol_overrides HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "replaced_protocol": "text",
    "replacement_protocol": "text"
  }
]

User activated upgrades

get

List of protocols to switch to at given levels

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

User activated upgrades: at given level, switch to given protocol.

levelinteger · min: -2147483648 · max: 2147483647Required

replacement_protocolone ofRequired

stringOptional

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/config/network/user_activated_upgrades

HTTPcURLJavaScriptPython

GET /config/network/user_activated_upgrades HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "level": 1,
    "replacement_protocol": "text"
  }
]