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.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”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
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.
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.
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.
The license owner’s email address.
The organization the license names.
The license’s ID, as issued.
The seat limit the license states. Left out when it sets none. Nothing enforces it today.
The number of days the license gives for counting active seats. Nothing uses it today.
The asset limit the license states. Left out when it sets none. Nothing enforces it today.
The license isn’t valid before this time.
The license stops being valid after this time.
When the license was issued.
Whole days left until exp, rounded down, as of when the license
was last checked. 0 in community mode.
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.
The issuer the license names. Verification accepts only
lic.artist-alley.org.
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.
True when the license is tied to an organization key: it works only
if this server holds the matching org.key file.
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.
Why the organization key check failed, in the verifier’s own words.
Where the server looks for org.key: /etc/artist-alley/org.key
unless AA_ORG_KEY_PATH sets another.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completed