Set a new Unleash license.

POST 
<your-unleash-url>/api/admin/license

Set a new Unleash license. Only available for self-hosted Enterprise customers.

Request

application/json

Bodyrequired

licenseUpdateSchema

tokenstringrequired

The actual license token.

Responses

201

The resource was successfully created.

Response Headers

location

The location of the newly created resource.

application/json

Schema

Schema

tokenstringrequired
The actual license token.
isValidboolean
Whether the license is valid or not.
customerstring
Name of the customer that owns the license. This is the name of the company that purchased the license.
typestringrequired
Type of license.
instanceNamestring
Name of the Unleash instance where this license is valid.
instanceIdstring
Identifier of the Unleash instance where this license is valid.
planstringrequired
Name of plan that the license is for.
seatsnumberrequired
Number of seats in the license.
expireAtdate-time
Date when the license expires.
Example: 2023-07-31T13:33:02Z
issuedAtdate-time
Date when the license was issued.
Example: 2023-07-31T13:33:02Z

Example (auto)

{
  "token": "string",
  "isValid": true,
  "customer": "string",
  "type": "string",
  "instanceName": "string",
  "instanceId": "string",
  "plan": "string",
  "seats": 0,
  "expireAt": "2023-07-31T13:33:02Z",
  "issuedAt": "2023-07-31T13:33:02Z"
}

400

The request data does not match what we expect.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ContentTypeerror
messagestring
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/license' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "token": "string"
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Body required

{
  "token": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!