Update license | Unleash Documentation

curl -X POST https://app.unleash-instance.example.com/api/admin/license \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lciI6IkFjTWUgQ29ycCIsImlzc3VlZEF0IjoiMjAyNC0wNi0xNVQxMjozMDowMFoiLCJleHBpcmVBdCI6IjIwMjUtMDYtMTVUMTI6MzA6MDBaIiwicGxhbiI6IkVudGVycHJpc2UiLCJyZXNvdXJjZXN"
}'

{
  "isValid": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lciI6IkFjTWUgQ29ycCIsImlzc3VlZEF0IjoiMjAyNC0wNi0xNVQxMjozMDowMFoiLCJleHBpcmVBdCI6IjIwMjUtMDYtMTVUMTI6MzA6MDBaIiwicGxhbiI6IkVudGVycHJpc2UiLCJyZXNvdXJjZXN",
  "customer": "Acme Corporation",
  "type": "Enterprise",
  "instanceName": "Acme Unleash Instance",
  "instanceId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "plan": "Enterprise Plan",
  "resources": {
    "seats": 50,
    "releaseTemplates": 10,
    "edgeInstances": 5,
    "readOnlyUsers": 20
  },
  "expireAt": "2025-06-15T12:30:00Z",
  "issuedAt": "2024-06-15T12:30:00Z"
}

Enterprise feature

Set a new 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

Request

licenseUpdateSchema

tokenstringRequired

The actual license token.

Response headers

locationstringOptional

The location of the newly created resource.

Response

The resource was successfully created.

isValidboolean

Whether the license is valid or not.

tokenstringOptional

The actual license token.

customerstringOptional

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

typestringOptional

Type of license.

instanceNamestringOptional

Name of the Unleash instance where this license is valid.

instanceIdstringOptional

Identifier of the Unleash instance where this license is valid.

planstringOptional

Name of plan that the license is for.

resourcesobjectOptional

The resources available in the license.

expireAtstringOptionalformat: "date-time"

Date when the license expires.

issuedAtstringOptionalformat: "date-time"

Date when the license was issued.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

415

Unsupported Media Type Error