OdooWiki OCA HUB

Auth Api Key Server Environment

auth_api_key_environment folder_open OCA/server-auth open_in_new
Uncategorised License: LGPL-3

This module makes the Server Environment features available for API Keys. For more information, please refer the corresponding module documentation.

auto_awesome What this module does

AI-generated from the code · Odoo 12.0

This module lets you store and manage API keys through Odoo's server environment configuration files instead of typing them directly in the database. It is a glue module that installs automatically when both API Keys and Server Environment are present.

This module connects two existing features: API Keys (used to authenticate external calls to Odoo) and Server Environment (which reads configuration values from files on the server rather than from the database).

Once installed, the API key value is no longer taken only from the record in Odoo. It can be supplied by the server configuration file, which is useful when you do not want sensitive keys stored in the database or visible in the user interface.

The configuration section used for each key is built from the key's name, so each API key has its own section in the configuration file. The module also declares that the key field is the one managed by the server environment.

It adds no new menus, screens, buttons or reports. It works behind the scenes on the auth.api.key model, extending it with the server environment behaviour. Because it is a glue module, it is installed automatically as soon as both auth_api_key and server_environment are installed, and it has no separate menu of its own.

Models and fields (1)
  • auth.api.key · new model

Text generated by AI (DeepSeek) from reading the Odoo 12.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-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 1 confirmed, 8 with no information of 9 versions.

Sources · Odoo 12.0

Confirmed on 2026-11-03 in branch 12.0 of OCA/server-auth.

terminal Installation and usage

OCA documentation · Odoo 12.0

The API key menu is available into Settings > Technical in debug mode. By default, when you create an API key, the key is saved into the database.

Using Server Environment, it is also possible to provide the value of this key via the configuration file. This can be very useful to avoid mixing your keys between your various environments when restoring databases.i

All you have to do is to add a new section to your configuration file according to the following convention:

[api_key_<Record Name>]
key=my_api_key

No verified information in OCA: Installation, Usage.

info

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.