Basic configuration settings

You can specify the API Connect basic configuration settings directly in the CR or with the Platform UI in Cloud Pak for Integration.

Review the tables for information on configuration settings for the following areas:


Table 1. Details
Field Type Required Description
Name String Yes Name this instance using only lowercase alphanumeric characters plus the underscore "-". Maximum of 54 characters.

Default: none


Table 2. License
Field Type Required Description
License acceptance Boolean Yes The license agreement must be accepted before you can install the API Connect capability. Default value: false (off).

In the UI, click the License acceptance toggle to enable it. In the CR, set the accept: field to true to accept the license.

License use String Yes Select production or nonproduction, to match the license you purchased.

Default: nonproduction

License metric Enumerated No Enter the unit of measure that is used for your program license:
  • PROCESSOR_VALUE_UNIT - Default value. If you leave the field blank, this value is used.
  • MONTHLY_API_CALL - Applies only to the IBM API Connect Hybrid Entitlement program.
Cloud Pak for Integration
  • VIRTUAL_PROCESSOR_CORE - Default value. If you leave the field blank, this value is used.
  • MONTHLY_API_CALL - Applies only to the IBM Cloud Pak for Integration - API Calls add-on program.

For information on tracking monthly call volume, see Tracking API volume for auditing and compliance.

License ID String Yes Select the license that you purchased for this instance of API Connect. Valid licenses are based on the selected value in the Product version field (see Table 4). When deploying the standalone IBM API Connect product, you must select the License ID for the API Connect program that you purchased. To view all License IDs, see API Connect licenses.

Deployment profiles for installing with a single, top-level CR

Select a deployment profile for the new installation. See API Connect deployment profiles for OpenShift and Cloud Pak for Integration for more information on the available profiles.

For information on switching to a different deployment profile after installation, see the following topics:

Product version

Table 3. Product version
Field Type Required Description
Product version Enumerated No Select the product version to be installed in the system.
Warning: Do not select a channel here instead of the API Connect version. Selecting a channel will result in any API Connect interim fix updates being applied automatically and without warning.

Storage class

Table 4. Storage class
Field Type Required Description
Default Storage Class Enumerated No Specify the RWO block storage class to use for persistence storage. This will be used when creating a PVC. Specification of the storage class is optional, but is highly recommended.

If not specified the default cluster storage class is used.

See the IBM Cloud Pak documentation for guidance for Storage class selection. Go to the following page and select your Cloud Pack release level: In the navigation panel, select System Requirements > Storage.

To review API Connect storage support, see Storage classes.