Set Configuration

POST {{HDB_ENDPOINT}}

Modifies the HarperDB configuration file parameters. Must follow with a restart or restart_service operation.
Read more about HarperDB configuration here: https://harperdb.io/docs/reference/configuration-file/.

**Operation is restricted to superuser roles only**_

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

  • logging_level(example/optional) -
    one or more configuration keywords to be updated in the HarperDB configuration file

  • clustering_enabled(example/optional) -
    one or more configuration keywords to be updated in the HarperDB configuration file

Request Body

{"operation"=>"set_configuration", "logging_level"=>"trace", "clustering_enabled"=>true}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"message":"Configuration successfully set. You must restart HarperDB for new config settings to take effect."}