Online Help

Licensing Reference

Reference for the AlloyScan licensing surface: the instance-level license and the per-Site Max caps that partition it.

Scope and roles

Note: This page covers instance-level administration in App Management. It is used by Global Administrators.

Surface Scope Typical role Purpose
App Management > Billing > License Information Instance Global Administrator Review and upload the instance license.
App Management > Billing > Limits and usage Instance Global Administrator Review instance-level quota consumption.
Site Settings > Limits and usage One Site Site Administrator Review usage for the current Site.
Site Settings > Organization profile One Site Site Administrator Configure per-Site Max caps.

Instance-level license fields

Configured at Admin Center > App Management > Billing > License Information.

Field Type Values Default Description
Serial No. String Format XXXXX-XXXXX-XXXXX-XXXXX-XXXXX - License serial.
Expiration Date YYYY-MM-DD - License expiration date.
Organization String Free text - Licensee name.
User String Free text - License contact.
Upload license Action License file - Replaces the current license with a new license file. Global Administrator only.

Instance-level Discovery quotas

Quota Type Values Cap type Description
Nodes Integer or Unlimited Number or unlimited Hard Maximum audited devices on the instance.
Users Integer or Unlimited Number or unlimited Hard Maximum users on the instance.
Audits per month Integer or Unlimited Number or unlimited Soft, monthly recharge Maximum audits consumed in a billing month; counter resets on the recharge day.
API transactions per month Integer or Unlimited Number or unlimited Soft, monthly recharge Maximum API transactions consumed in a billing month; counter resets on the recharge day.
Recharge day Integer 1..31 - Day of month on which the two monthly counters reset.

Limits and usage fields

The Limits and usage pages summarize subscription timing and current usage.

Field Applies to Description
Next billing date Subscription information Date of the next subscription billing cycle.
Monthly usage reset date Subscription information Date when monthly usage counters reset. This can be unlimited for subscriptions that do not enforce a monthly reset.
Users Limits Licensed user slots and current usage.
Devices Limits Licensed audited-device slots and current usage.
Audits per month Limits Monthly audit allowance and audits already consumed in the current period.
API transactions per month Limits Monthly API transaction allowance and transactions already consumed in the current period.

Per-Site Max caps

Configured at Admin Center > Site Settings > Organization profile and reviewed at Admin Center > Site Settings > Limits and usage.

Field Type Values Default Cap type Description
Max # of users Integer 0 = inherit instance - Hard Per-Site maximum user count.
Max # of audit nodes Integer 0 = inherit instance - Hard Per-Site maximum audited devices.
Max # of audits Integer 0 = inherit instance - Soft, monthly recharge Per-Site maximum audits per billing month.
Max # of API transactions Integer 0 = inherit instance - Soft, monthly recharge Per-Site maximum API transactions per billing month.

Cap types

  • Hard cap - exceeding the cap is prevented. New users cannot be invited beyond Max users; new audited devices cannot be added beyond Max audit nodes.
  • Soft cap with monthly recharge - the counter increments through the month and resets to zero at the start of the recharge day. Reaching the cap blocks further consumption until the next recharge.

States

  • Within cap - usage is below the Max; operations proceed normally.
  • Near cap - usage is approaching the Max; monitor closely on the Limits and usage page.
  • At cap (hard) - further additions are blocked; remediate by raising the cap or removing existing entries.
  • At cap (soft) - further consumption is blocked; remediate by waiting for the next recharge day or by raising the cap.

Limit notifications

AlloyScan uses three notification levels to help administrators react before a quota causes disruption.

Level Color Meaning
Informative Green Advance notice that usage is moving toward a license limit.
Warning Yellow Usage is approaching a limit and should be reviewed soon.
Critical Red A limit has been reached and immediate action may be required to avoid blocked operations or additional charges.

Constraints

  • A Max value of 0 on a per-Site quota means "no per-Site cap; inherit from the instance license".
  • The recharge day is instance-wide and applies to both monthly counters.
  • The exact per-second / per-minute API rate ceiling enforced by the server is not exposed in the UI; only the per-month counter is visible.
  • License upload is Global-Administrator-only.