Release Notes - 2023

Version 2023.08.1

Publication Date: July 28, 2023

APNZ-3746 The following command must be executed in the database during the update due to the change specified in the article:
For MongoDB v6.0 and later:

mongosh "mongodb://MONGOIPADDRESS:25080/apinizerdb" --eval 'db.getSiblingDB("admin").auth("apinizer", "MONGODBPASSWORD"); db.getSiblingDB("apinizerdb").apinizer_log.drop();'

CODE

MongoDB v6.0 öncesi için:

mongo "mongodb://MONGOIPADDRESS:25080/apinizerdb" --eval 'db.getSiblingDB("admin").auth("apinizer", "MONGODBPASSWORD"); db.getSiblingDB("apinizerdb").apinizer_log.drop();'

CODE

APNZ-3709 the following entry should be added to the cache deployment during the update due to the change mentioned in the article.

          - name: CACHE_SERVICE_NAME
            value: cache-http-service.ENVIRONMENTNAME.svc.cluster.local

CODE

IMPORTANT IMPROVEMENTS AND CHANGES

• It is now possible to set the initial log level of the Worker using an environment variable. See. Additionally, this issue also removes the 1-hour time-to-live (TTL) limit on application logs stored in MongoDB, making them retained indefinitely.

• Support has been added for generating a JWK (JSON Web Key) from a Public Key, Secret Key, and Certificate. See.

• Various improvements have been made to tasks under the API Integrator:

  • A toggle option to enable/disable tasks has been added.

  • A button has been introduced to add default parameter values in loop-type tasks' syntax area.

  • The variable selection list has been improved.

  • A new "Output Key" field has been added.

• On the API Proxy Template screen, Connection Settings and Log Settings based on routing have been introduced. See.

• The reset schedule of quota policies has been updated to follow the local time zone instead of UTC.

• The Anomaly Detector’s logic has been updated, and the screen’s user experience has been improved. See.

• Database and LDAP connection definitions can now be tested per environment. See1, See2.

• The uniqueness validation of relative paths has been revised:

  • Previously enforced at the Proxy, Proxy Group, and Project level,

  • It is now enforced per environment.

• The user experience of Gateway Environment screens has been improved. See1,See2.

• A new "Backend API Version" metadata field has been added to API Proxies. This version is now also shown in the Deployment History. See.

• The Connection Pool configuration can now be customized per route with in the API Proxy’s routing section. See.

• All report screens have been consolidated under the "Reports" menu.

BUG FIXES

Version 2023.06.1

Publication Date: June 7, 2023

NEW FEATURE

• Manual Kubernetes Management

By default, Gateway and Cache servers were defined and managed in Kubernetes via Apinizer. This version allows for manual management of existing Kubernetes clusters by simply defining the relevant metadata. This makes managing Kubernetes environments through the Apinizer management console optional.See.

• Creating a Personal API Access Token

A Personal API Access Token is a token used to authenticate the user when accessing the Apinizer Management API, in place of a password. It is generated specifically for the user who logs into the management console. See.

• Restoring API Proxy based on Deployment History

API Proxy can be restored to its previous revision (deployed state) via the deployment history. See.

IMPORTANT IMPROVEMENTS AND CHANGES

• The user experience of the date filtering fields on screens where Job results are displayed has been improved.

• The user experience of the General Settings screen has been enhanced.

• A new save and update method has been added to ApiOps for API Proxies, allowing the creation of a new record if the API Proxy does not exist, or updating it if it does.

• In the ApiOps API, during API Proxy save/update operations:

  • If specified in the request payload, the proxy is automatically deployed after being saved.

  • Routing configurations can also be set during the save operation.

BUG FIXES

Version 2023.05.1

Publication Date: May 18, 2023

Since this version upgrades the encryption method of sensitive data stored in the database, it is strongly recommended to backup the database before updating.

NEW FEATURE

• Defining SNMP Connection Configuration

SNMP connection definitions can be made to send data to monitoring tools that support SNMP protocol via Apinizer. See.

• Creating an Action with SNMP

By using SNMP Connection definitions, it is ensured that the data on the actions that occur can be sent to the monitoring systems. See.

• Completely Turn Off Elasticsearch Logging

By default, Apinizer manages the logging process with Elasticsearch and performs all queries for analytics operations on the Manager console on Elasticsearch. If desired, this feature can be disabled. It should be noted that when disabled, the analytics module will be deprived of some policies and monitor features. See.

• Transferring Logs to Another System with Kafka Integration

By default, the elements of the incoming and outgoing message to and from the API Proxy are kept on Elasticsearch. By doing Kafka Integration, messages can be transferred to a different application on the queue system. See.

• mTLS Authentication Policy

The mTLS Authentication (Mutual Transport Layer Security Authentication) Policy is one of the authentication methods on the Apinizer side. This method is a type of TLS protocol used to create a secure channel between the client and the server. When mTLS Authentication is used, the Apinizer checks the validity of the client's certificate in incoming requests and ensures that a trusted certificate authority (CA) is used to ensure that it comes from a specific certificate authority.. See.

• Apply mTLS Setting on Demand

mTLS configuration can be activated via Routing settings. Thus, the Apinizer client, which will send from Apinizer to the target service, verifies the certificate of the target service and indicates that it also has a certificate and should be verified by the target service. The target service validates the client's certificate and thus establishes a secure communication with the client. See.

• Apply mTLS Setting to Credential

If it is desired to be able to verify the certificate with the Credential's mTLS Authentication Policy, the certificate for the Credential can be installed. See.

• API Proxy Group-based Log Settings

The incoming and outgoing message information of the API Proxies added to the API Proxy Group can be logged in the Elasticsearch database according to the message elements (header, parameter, body) or the logs can be transferred to a defined system (Syslog, Webhook, RabbitMQ, Kafka). See.

IMPORTANT IMPROVEMENTS AND CHANGES

• The cache functionality of the API Call policy has been updated to check the presence of the Cache-Control header at the moment the request reaches the API Call policy, rather than whether the header exists on the incoming request to the API Proxy.

• An "Export" option has been added to the menu of the Global Policies listing screen.

• Definitions within the Decryption, Encryption, and Digital Signing policies are now editable.

• The project information has been added to the API Proxy ACL and API Proxy Group ACL listings.

• It is now possible to create Query, Filter, and Report Generator components on an application basis. See.

• The API Proxies menu under the application-level Analytics section has been merged into the Overview page.

• IP Group values can now be imported or exported.

• The Audit Records screen now includes filters to search by Object Name and Keyword.

• Search functionality in the Project dialog has been improved.

• Credentials can now be imported or exported.

• Database Connection Definitions can now be imported or exported.

• Filter options and table readability have been improved in the API Integration detail screen.

• JOSE Validation and JOSE Signing policies can now be applied to both request and response pipelines.

• Authorization fields have been added to the JOSE Validation policy when applied to the request pipeline.

• If a policy defined in an API Proxy Group will not be applied to a specific API Proxy, a warning icon is now displayed.

• New fields have been added to the DB2API method creation settings to optimize JSON data processing.

• The display of Keypair and Keypair Set information generated with JWK has been updated for better visibility.

• The encryption algorithm used for sensitive data stored in the database has been upgraded.

• A new option (Status Code List) has been added to the Error Handling Type field under Routing connection settings.

• For traffic logs, requests that do not reach the API Proxy can now be included or excluded in log exports, configurable via General Settings.

BUG FIXES

Version 2023.03.1

Publication Date: March 14, 2023

NEW FEATURE

• Creating a JSON Web Keypair Set

JWK stores public keys or keypairs in JSON format. Keys, key sets, keypairs, or keypair sets can be created in four different types (RSA, EC, OCT, OKP) using four different methods (convert from key store, retrieve from URL, paste to clipboard, and generate). These key definitions are used to validate or sign the message content in the request using JOSE policies, and to decrypt or encrypt the content in the response line.

•  JOSE Verification Policy

JOSE (Javascript Object Signing and Encryption) is a solution used to facilitate the secure transfer of "claim," or generally JSON, data between any two parties. The JOSE Verification Policy performs signature verification of signed data and decryption of encrypted data.

•  JOSE Implementation Policy

JOSE (Javascript Object Signing and Encryption) is a solution used to facilitate the secure transfer of "claim," or generally JSON, data between any two parties. The JOSE Implementation Policy is used to sign and encrypt data.

• Elasticsearch Configuration

If you want to write logging to Elasticsearch from an external system rather than directly through Apinizer, Elasticsearch can be placed in read-only mode. In this case, Apinizer stops writing outgoing message logs to the Elasticsearch cluster via the API Proxy, and only active reading of the logs is performed. This allows for querying operations run by analytics screens to continue. 

•  Transferring Logs with Webhook Integration

By default, message elements sent to and from the API Proxy are stored in Elasticsearch. With Webhook integration, message logging can be transferred to a different application.

•  Transferring Logs to Another System with RabbitMQ Integration

By default, message elements arriving and departing from the API Proxy are stored in Elasticsearch. With the RabbitMQ integration, messages can be transferred to a different application via the queuing system.

• Creating Alarms for System Information

In real-time systems, it's crucial to catch resource utilization issues before they become problems to prevent application performance degradation. This prevents potential problems by providing solutions. Alarms monitor the Kubernetes modules and Elasticsearch clusters within the Apinizer Platform according to predefined trigger types. If a given threshold is exceeded, a notification is generated in the application.

• A new Action type: Creating a Notification

When creating an Anomaly Detector, Runtime Monitor, API Integrator, or Alarm, a new action, "Create a notification," can be added at the end of the timer to process the result. This way, when each job definition is run, notifications are sent to all users or to the users for whom notifications are requested. Users can manage their notifications from the application's interface.

• Managing Notifications

Notifications are generated on Apinizer for three different situations: notifications showing action results, Account/Developer creation requests, and API Product subscription requests. All notifications can be viewed from the icon in the application's header or managed by clicking on the relevant notification category.

• Creating a Connection Definition from MongoDB

A new type of database connection configuration, MongoDB, has been added.

• Creating a DB-2-API Find Method with MongoDB

When creating an endpoint from the database with Db-2-API in the API Creator module, an endpoint can be added by writing a find query with the MongoDB configuration.

• Checking All API Proxy Log Settings on a Project or Application Basis

Previously, logging was configured on three different levels: Project, API Proxy Group, and API Proxy. To improve usability and manageability, logging settings have been reduced to a single API Proxy level. There are three screens for enabling or disabling logging settings; these can be configured on each API Proxy page, or multiple API Proxy logging settings can be configured on a per-project and application basis through the Log Settings screen.

• Defining Pod Probes from the Kubernetes Resources Screen

Kubernetes uses probes to know when its container is ready to restart and when to start it. Essentially, probes check the health of containers and ensure that unresponsive applications are restarted. Pod probes are defined through Apinizer.

IMPORTANT IMPROVEMENTS AND CHANGES

• The user experience of the Actions dialog and the Create Action/View dialogs has been improved.

• When creating an API Proxy through Spec Design, it is now possible to continue designing from the generated spec definition.

• An append operation has been added to the body manipulation step in the API Call policy for modifying the original message data.

• A new filter has been added to the API Proxy list to allow searching based on deployment status.

• A refresh button has been added to the table displaying pod statuses on the Kubernetes Resources screen.

• Copy as cURL and export to Excel features have been added to the API Proxy Traffic screen.

• The Report Generator screen now supports editing queries and filters, as well as copying the query as cURL.

• The storage of JWT tokens has been made independent of the database.

• Certificates, Keys, and Key Store screens can now be managed on a per-project basis.

• For audit logs, the IP address of Manager Console logins is now obtained from the X-Forwarded-For header.

• The restriction requiring at least two addresses to display Circuit Breaker in the Routing tab of API Proxy has been removed.

• Time-related fields (Total Time, API Proxy Time, Backend Time) on the Report Creation and Query screens have been revised.

• The database connection configuration screens have been unified.

• A new Log Settings tab has been added to the API Proxy screen, separating all log-related configurations from the Settings tab.

• Definitions for Uptime Monitor and Anomaly Detector can now be managed per application.

• Required credential fields in database connections have been made optional to support connections that do not require authentication.

• In the Plain-Text Authentication policy, the password field has been made optional, allowing services to be authorized using only an API Key.

• In the Authorization Configuration policy, roles can now be retrieved without enforcing role validation.

• In JWT, OAuth2, and JOSE Validation policies, if an Identity/Authorization Service is selected, roles from this service can now be added to the request header.

• Sensitive Data Management and Syslog Integration screens have been moved under the Log Settings menu.

• KPS Configuration and ProCrypt screens have been moved to the System Settings menu.

• The API Proxy Report has been moved to the Analytics menu.

• The ACL Report screen has been moved to the Identity Management menu. Previously limited to application-based access, it is now also accessible via the project menu.

• The API Proxies screen under the Analytics menu has been removed; its table data has been merged with the table view of the API Proxy Report screen.

• A JWK Settings tab has been added to the Credentials screen to allow selection of JWKs to be used in JOSE policies.

• Support for OpenAPI version 3.0.3 has been added.

BUG FIXES