Skip to main content

Audit log

Get an audit log signing key (all configuration) and on Encedo PPA only get a log list & files.

Allowed usersUser✓Master✓ExtAuth✓
Required access scopelogger:get

Get a log signing key​

GEThttps://my.ence.do/api/logger/key

Return a key used to sign the log file header as proof of the source's digital authenticity.

Headers​

NameTypeDescription
Authorization*StringBearer JWT_TOKEN

Response status code​

{
"key": "T61jY1AgV5XUW++eAcQibRDFOl5KjKwLGdo+U0def8A=",
"nonce": "P4M0YrCmPemejJg2zRYFPl4uZu7p8kG1IQDnrRHLMZg=",
"nonce_signed": "/rgJmzoAbGLIQEg/meAxF2vrYWcvFnbeMNkaQDfS8RKvaBuj7/HPcObkz9X0HX+V53xyh8YJR+lJ6AO727PRBQ=="
}

Response data for successful operation​

NameTypeDescription
keyStringBase64 encoded ED25519 public key
nonceStringBase64 encoded random nonce
nonce_signedStringBase64 encoded ED25519 signature of the nonce.

Log entries​

EventResultSource
LOG_TYPE_FAILED_SCOPE_CHECKLOG_RESULT_FAILED403

Get a list of log entries​

info

Embedded Flash Drive is available on Encedo PPA only. On Encedo EPA these two endpoints are not available, response code 404 will be returned.

Get a list of logs​

GEThttps://my.ence.do/api/logger/list
GEThttps://my.ence.do/api/logger/list/{offset}

Get a list of available log files.

Path Parameters​

NameTypeDescription
offsetNumberSkip 'offset' logs entries

Headers​

NameTypeDescription
Authorization*StringBearer JWT_TOKEN

Response status code​

{
"total": 3,
"id": ["62310b2b", "62310bf6", "6231f603"]
}

Response data for successful operation​

NameTypeDescription
totalNumberTotal number of logs entries.
idArray of stringsAn array of logs File IDs

Log entries​

EventResultSource
LOG_TYPE_FAILED_SCOPE_CHECKLOG_RESULT_FAILED403
LOG_TYPE_LOGGER_LIST_LOGLOG_RESULT_OK200
LOG_TYPE_LOGGER_LIST_LOGLOG_RESULT_FAILED404
info

A maximum of 128 log entries are returned by one call. Use the offsetargument for pagination.

Get a log file​

info

Embedded Flash Drive is available on Encedo PPA only. On Encedo EPA these two endpoints are not available, response code 404 will be returned.

Get a log file​

GEThttps://my.ence.do/api/logger/{file}

Get a log file for a given ID.

Path Parameters​

NameTypeDescription
file*StringFile ID e.g. "62310b2b"

Headers​

NameTypeDescription
Authorization*StringBearer JWT_TOKEN

Response status code​

# Encedo HEM v0.9.77 (#ff0a263)
0|62310ba5|0|0|NgPWx9MnmngrKa7xkSuQnDcwBlDV5JeR0OoX6gFyMpo|sMfJhY2jjkQLb7dVGlWf_GynEOTZVh5tO33k8Iq52jB0CAECs1ysU3NenhlmWBWyTo1XEaqL-ysBVB7quNHDBA|XEwWbRXrh65JPjAjb-9bwg
1|62310ba5|1|0|||rfB1gKL0hTi5tGh8PDerAA
2|62310ba5|7|0|||dsutQDgmuLtecPIwPDctdA
3|62310ba5|13|0||NQsxYg|bODm1bUzTiX6qS7LheDJFA
4|62310ba6|1d|0|M||9b_vMf0QXC-qEhi-kQ4zpg
5|62310bdd|12|0|U||Rhwgm9ZQx-RGfrjESNxhDQ
6|62310c0c|2|0|U||IhCfo8F_OHBLhgOGXE5vPA

Log entries​

EventResultSource
LOG_TYPE_FAILED_SCOPE_CHECKLOG_RESULT_FAILED403
LOG_TYPE_LOGGER_READ_LOGLOG_RESULT_OK200
LOG_TYPE_LOGGER_READ_LOGLOG_RESULT_FAILED404