4.8. Method: create


Description

Create a new activation key. The passed activation key parameter is prefixed with the organization ID. This value is returned from the create call. For example, if the caller passes in the key foo and adds to an organization with the ID 100, the actual activation key will be 100-foo. This allows setting a usage limit on this activation key. If unlimited usage is desired, use a create method that does not include this parameter.

Parameters

The following parameters are available for this method:

  • string sessionKey
  • string key - Leave empty to have new key generated.
  • string description
  • string baseChannelLabel - Leave empty to accept default.
  • int usageLimit - If unlimited usage is desired, use a create method that does not include this parameter.
  • array:
    • string - Add-on entitlement label to associate with the key.
      • monitoring_entitled
      • provisioning_entitled
      • virtualization_host
      • virtualization_host_platform
  • boolean universalDefault
Returns

The following return values are available for this method:

  • string - The new activation key.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat