Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/modules/logs/add

Requires JWT

Add a log entry for a module.

A maximum of 50 log entries are kept, earlier ones are discarded.

Note: don't log sensitive configuration fields like passwords or API keys.

Request

POST /api/p/<project gid>/modules/logs/add

Authorization: Bearer <JWT>

{
    "module": "Update Catalog",
    "version": "1.0.11",
    "action": "Action Name",
    "configuration": {
        "apikeyname": "Not The Actual API Key Please",
        "query": "All articles",
        …
    },
    "command": "generate",
    "started_at": 1610634813.62983,
    "ended_at": 1610635126.04762,
    "status": "ok",
    "output": "plain text output",
}

module name of the module to add the log for
version current version of the module

optional

action name of action configuration
configuration the configuration fields as a dict, must be a valid json value (not a json-value-as-a-string!) - remember to redact sensitive information!
command the name of the command
started_at timestamp for when the action started
ended_at timestamp for when the action ended
status status reported upon completion of the action
output the plain text output from running the command

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "module": "<module name>"
    },
    "data": {
        "modules": {
            "<module name>": {…}
        }
    }
}

result

module the name of the module.

data

modules Module info with name, version, keys, actions, and logs.

Error responses

400 Bad request - missing parameters or wrong type or value
401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of this project
422 Unprocessable entity - module not registered