License NGINX Controller

Overview

This topic explains how to upload and manage licenses for NGINX Controller.

License Types

NGINX Controller licenses can be either connected or disconnected licenses:

  • A connected license sends telemetry data to F5, which enables pricing based on usage. When adding a connected license, you must provide a customer Association Token, which you can get from the MyF5 Customer Portal.
  • A disconnected license doesn’t send telemetry data to F5. To add a disconnected license, you can upload the license file using the NGINX Controller web interface or the NGINX Controller API.

Get Your License

To access your license, get your Customer Access Token, or sign up for a trial license, visit the MyF5 Customer Portal.

Add a License to NGINX Controller

To add a license to NGINX Controller, take the following steps:

  1. Go to https://<Controller-FQDN>/platform/license and log in.

  2. In the Upload a license section, select an upload option:

    • Upload license file – Locate and select your license file in the file explorer.
    • Paste your Association Token or license file – Paste your customer Association Token or the contents of your NGINX Controller license file. These are available on the MyF5 Customer Portal.
  3. Select Save license.

See Also:
To add a license using the NGINX Controller API, send a PUT request to the /platform/license endpoint. Provide your CAT or NGINX Controller license as a base64-encoded string in the JSON request body.

View Information about a License

To view information about your license – including the expiration date, license type, status, and any license limitations – send a GET request to the /platform/license endpoint. See the NGINX Controller API Reference for details.

Update a License

To update a license, follow the same steps to add a license. Upload the new license to replace the previous one.

Note:
It’s not possible to replace a connected license with a disconnected license. To transition from a connected to a disconnected license, you first need to delete the connected license and then add the disconnected license.

Delete a License

To delete a license using the NGINX Controller API, send a DELETE request to the /platform/license endpoint.

License Features

When you license NGINX Controller, you have full access to all of the features included in the license.

If you haven’t licensed NGINX Controller, or if your license has expired, you can still access the following restricted set of features:

  • Log in and out of NGINX Controller
  • Manage licenses
  • Manage users
  • Manage user groups
  • Manage roles
  • Manage integration accounts
  • Manage support bundles
  • Manage backups
  • View alerts

This documentation applies to the following versions of NGINX Controller Documentation:
3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9 and 3.10.