Skip to content

Get the license status

GET
/admin/license/status

Returns the license state your instance has loaded: whether a license is in use, its tier and features, and when it expires. Without a license it reports community mode, which is how installs run today.

The answer comes from memory. When a license path is set, as it is by default, the server reads and verifies the file at startup, after an install with POST /admin/license/upload and again every 24 hours; this request reads nothing from disk and never contacts a license server. So days_until_expiry is as of the last check, and a file changed on disk shows up at the next one. If AA_LICENSE_PATH is set to an empty value, there are no file checks and the server stays in community mode.

If the file is missing at startup, the server runs in community mode with no error. If the file can’t be read, or fails a check (format, signature, issuer, dates or the organization key), the server also falls back to community mode and last_error says why. Either way loaded is false.

You need system.license.read or system.admin.

License snapshot.

The license state. loaded false means community mode: no license is in use and the built-in community features apply. Commercial licensing is planned but not offered today, so installs run in community mode.

Fields that don’t apply are left out rather than sent as null.

object
loaded
required

True when the license passed every check: it’s in use or, in a response from POST /admin/license/validate, it would be. False means community mode.

boolean
tier
required

community without a license. Otherwise the tier the license names, such as pro or enterprise, which belong to the planned licensing that isn’t offered today.

string
features
required

The features this status lists: what this install has or, in a response from POST /admin/license/validate, what the license would give. Community mode gives core, thumbnails, ai_enrichment, collab and api_access; a license replaces that list with its own. Only sso_ldap, sso_saml and multi_tenant are checked anywhere. The first two add LDAP and SAML to the sign-in options, but neither can sign anyone in; all three gate the admin capabilities that require them.

Array<string>
owner

The license owner’s email address.

string
org

The organization the license names.

string
lid

The license’s ID, as issued.

string
seats

The seat limit the license states. Left out when it sets none. Nothing enforces it today.

integer format: int64
nullable
seat_window_days

The number of days the license gives for counting active seats. Nothing uses it today.

integer
asset_cap

The asset limit the license states. Left out when it sets none. Nothing enforces it today.

integer format: int64
nullable
nbf

The license isn’t valid before this time.

string format: date-time
exp

The license stops being valid after this time.

string format: date-time
iat

When the license was issued.

string format: date-time
days_until_expiry
required

Whole days left until exp, rounded down, as of when the license was last checked. 0 in community mode.

integer
last_error

Why the last check failed, when it did: the file couldn’t be read, failed verification or didn’t match the organization key. The server is then in community mode. If a license path is set but there’s no file at it, this reports the missing file once the server has been up for a day.

string
iss

The issuer the license names. Verification accepts only lic.artist-alley.org.

string
path

Where the server reads the license file: /etc/artist-alley/license.lic unless AA_LICENSE_PATH sets another. May be left out in community mode.

string
org_binding_required
required

True when the license is tied to an organization key: it works only if this server holds the matching org.key file.

boolean
org_bound
required

True when there’s no organization key to match or this server’s org.key matches it. A license that doesn’t match isn’t loaded: the server stays in community mode and org_binding_error says why.

boolean
org_binding_error

Why the organization key check failed, in the verifier’s own words.

string
org_key_path

Where the server looks for org.key: /etc/artist-alley/org.key unless AA_ORG_KEY_PATH sets another.

string

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed