API Key Wildcard: Configuration
The two fields of the API Key Wildcard configuration in osTicket: Installed Version (read-only) and Log Wildcard API Access with default value, effect and content of the log entry.
API Key Wildcard: Configuration
Open the configuration in the osTicket Admin Panel under Manage → Plugins by selecting API Key Wildcard Support. The plugin has two fields. The labels appear in English in the Admin Panel.
| Field | Description | Default |
|---|---|---|
| Installed Version | Text field, disabled (not editable). Shows the most recently installed plugin version and is maintained automatically. | empty, set on activation and auto-update |
| Log Wildcard API Access | Enables the log entry when a wildcard key (0.0.0.0) is used. |
enabled |
Log Wildcard API Access
When the option is enabled, the plugin writes a debug entry titled Wildcard API Key Used to the osTicket system log for every successful request made with a key whose IP is 0.0.0.0. The message names the wildcard IP and the caller's IP.
- Requests made with a key bound to the caller's own IP create no entry.
- The caller's IP is cleaned with
Format::htmlchars(Format::sanitize())before it is written. - Whether debug entries are visible in the system log depends on the log level configured in osTicket.
- If the plugin is not active or its configuration cannot be read, the default applies (logging on).
With a high API volume you can turn logging off so the system log does not fill up.
Installed Version
The field is for checking only. On every bootstrap the plugin compares the value with the version in plugin.php. If the value is empty or lower, the automatic update starts (see Technical Details).
Instances
The plugin is a singleton: there is only one instance, and on activation it is created automatically if it is missing.