This module adds a "ref" field in the error response of FastAPI. This field is an AES encrypted string that contains the error message / traceback. This encrypted string can be decrypted using the endpoint decrypt error wizard.
auto_awesome What this module does
AI-generated from the code · Odoo 16.0Adds an option on FastAPI endpoints to encrypt error details returned to API clients, and provides a wizard to decrypt those error references back into readable messages.
This module extends the FastAPI endpoint configuration in Odoo. On the FastAPI endpoint form, a new checkbox "Encrypt errors" lets you turn on error encryption. When enabled, a secret key is automatically generated and shown (read-only) to FastAPI managers, with a refresh button to generate a new key.
When an API call fails, instead of exposing the raw error message or traceback to the client, the error is compressed and encrypted, and the response includes a "ref" field containing the encrypted string. This helps keep internal details private while still allowing support staff to investigate.
A new menu item "Decrypt Error" appears under the FastAPI root menu, available to FastAPI managers. It opens a wizard where you paste the encrypted reference, choose the relevant FastAPI endpoint, and click "Decrypt Error". The wizard then shows the original error message or traceback in a read-only field. If decryption fails, the wizard displays the decryption error instead.
The module touches the fastapi.endpoint model by adding the encrypt_errors and encrypted_errors_secret_key fields, and introduces the transient model wizard.fastapi.decrypt.errors for the decryption wizard. Access to the wizard is restricted to the FastAPI manager group.
Depends on
Menus it adds
Models and fields (2)
- fastapi.endpoint · extends an existing modelencrypt_errors, encrypted_errors_secret_key
- wizard.fastapi.decrypt.errors · new modelerror, decrypted_error, fastapi_endpoint_id (FastAPI Endpoint)
Text generated by AI (DeepSeek) from reading the Odoo 16.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub
Availability by version
Reviewed: 2026-11-03Confirmation status: 1 confirmed, 8 with no information of 9 versions.
Sources · Odoo 16.0
Confirmed on 2026-11-03 in branch 16.0 of OCA/rest-framework.
terminal Installation and usage
OCA documentation · Odoo 16.0Usage
Source · Odoo 16.0First you have to enable the encryption for an endpoint by checking the Encrypt Errors checkbox in the endpoint configuration.
To decrypt an error message, you can use the "Decrypt Error" wizard in the FastAPI menu.
You can regenerate a new key by clicking on the "Regenerate Key" button next to the Errors Secret Key field.
No verified information in OCA: Installation, Configuration.
Installation instructions, the distribution package, dependencies and configuration steps are not shown because they have not yet been verified in the module documentation for any version.
Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.