Set Configuration

POST {{HDB_ENDPOINT}}

Modifies the HarperDB configuration file parameters. Read more about HarperDB configuration here: https://harperdb.io/docs/reference/configuration-file/.

Operation is restricted to super_user roles only

• operation (required) - must always be 'configure_cluster'
  

• configuration parameter(s) (optional) - one or more configuration keywords to be updated in the HarperDB configuration file
  

Request Body

{"operation"=>"configure_cluster", "PROJECT_DIR"=>"/Users/user/node_modules/harperdb", "HDB_ROOT"=>"/Users/user/hdb", "SERVER_PORT"=>9925, "CERTIFICATE"=>"/Users/user/hdb/keys/certificate.pem", "PRIVATE_KEY"=>"/Users/user/hdb/keys/privateKey.pem", "HTTPS_ON"=>true, "CORS_ON"=>true, "CORS_WHITELIST"=>0, "LOG_LEVEL"=>"info", "LOGGER"=>1, "LOG_PATH"=>"/Users/user/hdb/log/hdb_log.log", "LOG_DAILY_ROTATE"=>false, "LOG_MAX_DAILY_FILES"=>5, "NODE_ENV"=>"production", "CLUSTERING_PORT"=>"12345", "NODE_NAME"=>"documentation_node", "CLUSTERING"=>false, "ALLOW_SELF_SIGNED_SSL_CERTS"=>false, "MAX_HDB_PROCESSES"=>12, "CLUSTERING_USER"=>nil, "SERVER_TIMEOUT_MS"=>120000, "SERVER_KEEP_ALIVE_TIMEOUT"=>5000, "SERVER_HEADERS_TIMEOUT"=>60000, "DISABLE_TRANSACTION_LOG"=>false, "OPERATION_TOKEN_TIMEOUT"=>"1d", "REFRESH_TOKEN_TIMEOUT"=>"30d"}

HEADERS

RESPONSES

status: OK

{"message":"Successfully configured and loaded clustering configuration.  Some configurations may require a restart of HarperDB to take effect."}