Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/modules/keys/clear

Requires JWT

Remove one or more keys for a module.

If a key wasn't set on this module, no warnings or errors are triggered.

If you provide both key and keys parameters, we use parameter matching to guess what you meant. The first action that matches the parameters is performed, the rest is ignored. Parameter matching happens in the order given below:

Request

POST /api/p/<project gid>/modules/keys/clear
Authorization: Bearer <JWT>

{
    "module": "<module name>",
    "key": "any.string.key",
}

or

POST /api/p/<project gid>/modules/keys/clear
Authorization: Bearer <JWT>

{
    "module": "<module name>",
    "keys": [
        "any.string.key",
        "a.different.key",
    ]
}

module name of the module to clear the key from
key key to clear
keys a list of keys to clear

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