The engine's settings (owner only): every key of the settings file with its value, default, whether it applies at once or after a restart; secrets are never sent.
const url = 'https://example.com/datanotes/settings/';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/datanotes/settings/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{}'settings_version changes with every applied change and every start: send it as expect_version to /settings/update/. A named token is refused (403), even with maintain.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
Example generated
{}Responses
Section titled “Responses”Done.
object
The settings file; null on a host that keeps its settings in memory.
Opaque: changes with every applied change and every start.
The file was edited by hand since the engine read or wrote it: changes are refused until a restart.
The settings saved but waiting for a restart, in settings order.
Every key of the settings file, in its order.
One key of the engine’s settings file, with its rule. Secrets are never sent: the owner token has no value, header values and the credentials inside an address are hidden.
object
The settings file’s key (camelCase).
The kind of value it takes.
The value saved now. Absent when write_only; telemetryHeaders shows each header’s value as <redacted>; an address shows no user or password.
The value when the file does not set it. Absent for httpServerToken.
The value differs from the default (httpServerToken: it is set).
The allowed values in words, read after “
The allowed values of an enum.
The smallest value of an integer or number, when it has one.
The largest value of an integer or number, when it has one.
live: a change applies from the next request or background job; restart: at the engine’s next start.
False for the settings that change only in the settings file (tableKey, transactionLogFormat).
When not editable: why, and how to change it.
A restart setting whose saved value is not the one the engine runs with.
A start option of datanotes serve that wins over the setting, in words.
Its value is never sent (httpServerToken).
Something was hidden: header values, the credentials of an address, the token.
An address the engine sends data to.
What a change of it does, to show before it is saved.
Example
{ "settings": [ { "type": "boolean", "applies": "live", "write_only": true, "redacted": true, "sends_data": true } ]}Bad input: the body is not a JSON object, or an argument is unknown, missing or of the wrong type.
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}Missing or wrong bearer token.
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}A named token beyond its permissions (the engine’s administration, tables outside its write patterns, schema changes without ddl).
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}Unexpected error.
object
What went wrong, for a person or an agent.
Example generated
{ "error": "example"}