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 super_user roles only

  • operation (required) - must always be 'set_configuration'
  • hdb_user(required) - must be a string.
  • hdb_auth_header(required) - must be a string.
  • logging_level(example/optional) - one or more configuration keywords to be updated in the HarperDB configuration file

Request Body

{"operation"=>"set_configuration", "hdb_user"=>"example_user", "hdb_auth_header"=>"example_header", "logging_level"=>"trace"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

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