KB Article #177537

How do you replace an API Gateway license?

  • Problem

* How do you replace an API Gateway license? For example, replacing an evaluation license with a permanent license?

Resolution

-- The API Gateway stores license files in the directory [install dir]/conf/licenses/ so all you have to do is place the new license file in there and remove the old one, then bounce the gateway so that it's running on the new license. You can determine the parameters of the license, such as version and expiration date, by opening the license file with a text editor.

If for any reason your license isn't recognized, check the following items:

  • License files must have the .lic file extension.
  • Licenses must be readable by the gateway process. Be sure to check the file's ownership and read permissions.
  • The signature must be valid, so the license must not be edited in any way.
  • Some features are independently licensed and must be purchased. These require license features that show up as properties in the license. For example, Analytics requires the license to contain analytics=1, API Manager requires apiportal=1, McAfee requires mcafee=1, etc.
  • The hostname reported by the system must exactly match the hostname in the license file. The license check treats this field as case-sensitive, even though hostnames themselves are not.
  • Licenses that contain an expiration date must not be expired. Licenses without an expiration date listed never expire.
  • The versions must match. Note that only the generation and major version are normally set. So a 7.4.1 license will just say version=7.4.