Skip to main content

Get the license and its usage

GET 
/license

Returns the details of the installed license and, for each object type that the license covers, the limit and the number of objects in use. Configuration objects, such as pipelines, agents and API keys, are counted exactly. Documents and fragments are estimated from the PostgreSQL table statistics, which can lag behind recent loads, and are marked with estimated. valid and status report the license as Foundation4 enforces the license, from counts that Foundation4 refreshes periodically, so valid can differ from a comparison of used with limit for a short time.

Permissions. An admin API key: a key with read, write and execute permission on every object type that permissions apply to and the allow-list * on pipelines, such as the master key. The admin field of the POST /login response shows whether a key is an admin API key.

Responses​

The body holds the license details and the limit and usage of each object type.