Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/modules/actions/publish

Requires JWT

Publish the configuration for an action.

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

Request

POST /api/p/<project gid>/modules/actions/publish
Authorization: Bearer <JWT>

{
    "module": "<module name>",
    "action": "Action Name",
    "configuration": {
        "apikeyname": "Not The Actual API Key Please",
        "query": "All articles",
        …
    },
}

module name of the module to store the action configuration for
action the name for the 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!

Success response

Authorization: <JWT>

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

result

module the name of the modified 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