Get brokers' configurations

View as Markdown
GET /v1/node_config

List the configuration properties of all brokers (nodes) in the cluster.

For the broker configuration properties of the latest Redpanda version, see Broker Configuration Properties.

Responses

  • 200 application/json

    Brokers' configurations response

    Hide response attributes Show response attributes object
    • advertised_kafka_api array[object]
      Hide advertised_kafka_api attributes Show advertised_kafka_api attributes object
      • name string
      • address string
      • port integer
    • data_directory string

      Path to the directory for storing Redpanda's streaming data files.

      Default value is /var/lib/redpanda/data.

    • crash_loop_limit integer

      A limit on the number of consecutive times a broker can crash within one hour before its crash-tracking logic is reset. This limit prevents a broker from getting stuck in an infinite cycle of crashes. If null, the property is disabled and no limit is applied.

    • admin object
      Hide admin attributes Show admin attributes object
      • name string
      • address string
      • port integer
    • advertised_rpc_api object
      Hide advertised_rpc_api attributes Show advertised_rpc_api attributes object
      • name string
      • address string
      • port integer
    • kafka_api object
      Hide kafka_api attributes Show kafka_api attributes object
      • name string
      • address string
      • port integer
    • developer_mode boolean
    • admin_api_doc_dir string
    • rpc_server_tls object
      Hide rpc_server_tls attributes Show rpc_server_tls attributes object
      • enabled boolean
      • require_client_auth boolean
    • empty_seed_starts_cluster boolean
    • memory_allocation_warning_threshold integer
    • seed_servers array[object]
      Hide seed_servers attributes Show seed_servers attributes object
      • name string
      • address string
      • port integer
    • upgrade_override_checks boolean
    • rack string
    • rpc_server object
      Hide rpc_server attributes Show rpc_server attributes object
      • name string
      • address string
      • port integer
    • admin_api_tls object
      Hide admin_api_tls attributes Show admin_api_tls attributes object
      • enabled boolean
      • cert_file string
    • node_id integer
    • cloud_storage_cache_directory string
    • kafka_api_tls object
      Hide kafka_api_tls attributes Show kafka_api_tls attributes object
      • name string
      • key_file string
      • enabled boolean
GET /v1/node_config 
curl \ --request GET 'http://localhost:9644/v1/node_config'
Response examples (200) 
[ { "advertised_kafka_api": [ { "name": "string", "address": "string", "port": 42 } ], "data_directory": "/var/lib/redpanda/data", "crash_loop_limit": 42, "admin": { "name": "string", "address": "string", "port": 42 }, "advertised_rpc_api": { "name": "string", "address": "string", "port": 42 }, "kafka_api": { "name": "string", "address": "string", "port": 42 }, "developer_mode": true, "admin_api_doc_dir": "string", "rpc_server_tls": { "enabled": true, "require_client_auth": true }, "empty_seed_starts_cluster": true, "memory_allocation_warning_threshold": 42, "seed_servers": [ { "name": "string", "address": "string", "port": 42 } ], "upgrade_override_checks": true, "rack": "string", "rpc_server": { "name": "string", "address": "string", "port": 42 }, "admin_api_tls": { "enabled": true, "cert_file": "string" }, "node_id": 42, "cloud_storage_cache_directory": "string", "kafka_api_tls": { "name": "string", "key_file": "string", "enabled": true } } ]