Get license | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/license \
     -H "Authorization: <apiKey>"

{
  "isValid": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lciI6IkFjTWUgQ29ycCIsImlzVmFsaWQiOnRydWUsInR5cGUiOiJFbnRlcnByaXNlIiwiaW5zdGFuY2VOYW1lIjoiQWNtZSBTZXJ2ZXIiLCJpbnN0YW5jZUlkIjoiYWJjMTIzLWVmZDU2LTc4OWFiLWNkZWYwMTIzNDU2Nzg5IiwicGxhbiI6Ik9yZ2FuaXphdGlvbiIsInJlc291cmNlcyI6eyJzZWF0cyI6MTAwLCJyZWxlYXNlVGVtcGxhdGVzIjoxMCwiZWRnZUluc3RhbmNlcyI6MiwicmVhZE9ubHlVc2VycyI6MTV9LCJleHBpcmVBdCI6IjIwMjQtMTItMzFUMjM6NTk6NTlaIiwiaXNzdWVkQXQiOiIyMDIzLTAxLTAxVDAwOjAwOjAwWiJ9.abc123signature",
  "customer": "Acme Corporation",
  "type": "Enterprise",
  "instanceName": "Acme Unleash Server",
  "instanceId": "abc123-efd56-789ab-cdef0123456789",
  "plan": "Organization",
  "resources": {
    "seats": 100,
    "releaseTemplates": 10,
    "edgeInstances": 2,
    "readOnlyUsers": 15
  },
  "expireAt": "2024-12-31T23:59:59Z",
  "issuedAt": "2023-01-01T00:00:00Z"
}

Enterprise feature

Reads the Unleash license. Only available for self-hosted Enterprise customers.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

licenseReadSchema

isValidboolean

Whether the license is valid or not.

tokenstring or null

The actual license token.

customerstring or null

Name of the customer that owns the license. This is the name of the company that purchased the license.

typestring or null

Type of license.

instanceNamestring or null

Name of the Unleash instance where this license is valid.

instanceIdstring or null

Identifier of the Unleash instance where this license is valid.

planstring or null

Name of plan that the license is for.

resourcesobject or null

The resources available in the license.

expireAtstring or nullformat: "date-time"

Date when the license expires.

issuedAtstring or nullformat: "date-time"

Date when the license was issued.