Add License

Apply license to a workspace

You may want to deploy your workspace in an air-gapped environment. Since the server has no internet to communicate with the cloud, we provide an enterprise edition license that you can apply manually to upgrade your workspace.

It requires edit-privileged-setting permission.

URL	Requires Auth	HTTP Method
/api/v1/licenses.add	yes	POST

Headers

Argument	Example	Required	Description
X-User-Id	myuser-name	Required	The authenticated user ID.
X-Auth-Token	myauth-token	Required	Auth token.

Payload

Argument	Example	Required	Description
license	VFJ0vHf3Jm9AR0minB342MLaHRlZdc3Du5nf0E5Sv0QJ4SUkEIaU2boCYaDsxQ2N1UL4uhLjCF9M7iCZ/yxafJjxbHvOu1D5rOfdgO4RKlAGE9tGHDidowiw9crJyXVb16jPHHoeh7nFcI1gxbwGKcB1c4SdFXgQYYb8RCCFMQ64pdZUiXIIq/nUXxU8gEgT3sjJ9u2+Dw5ukDLX3SG2AFq1hLoPSZqsP6giSOKBXTx9t8qVrT5COEn4CWCaVdApOdWC2nsROTJPJPbyjdZ9uSXQEr4raeHZXgtb9L3u2+wUej7NwDJ+C9+/6jUjmUD+CZyvpiv1YBWFudCjsgm8chrtzab70ndw1hjSXVMiuO00/wcHg8aTwZ7GSUA+OH1h1DCG4Bxrd94eZwZxEOgQtP01aNaM/RyYaleib88o6zjD0oDDISaN7nwv6F85v7FfRPEWAVZ5HUNVWxiqJqx/fAGvr9tTwtfnBwpcZXssJytefriAqDsslZYTl7FzAxryo9pDioNSozLMwhCfAVm0VdIt0Ma4s0i72eUtgRnvAAq1bZK6UkE0zE8xMQjOykoiCoQLzwza+g762AQo=	Required	The EE license

Example Payload

{
    "license":"VFJ0vHf3Jm9AR0minB342MLaHRlZdc3Du5nf0E5Sv0QJ4SUkEIaU2boCYaDsxQ2N1UL4uhLjCF9M7iCZ/yxafJjxbHvOu1D5rOfdgO4RKlAGE9tGHDidJR9crJyXVb16jPHHvLSkUFzb7HoIq/nUXxU8gEgT3uJ9u2+Dw5ukDLX3SG2AFq1hLoPSZqsP6giSOKBXTx9t8qVrT5COEn4CWCaVdApOdWC2nsROTJPJPbyjdZ9uSXQEr4raeHZXgtb9L3u2+wUej7NwDJ+C9+/6jUjmUD+CZyvpiv1YBWFudCjsgm8chrtzab70ndw1hjSXVMiuO00/wcHg8aTwZ7GSUA+OH1h1DCG4Bxrd94eZwZxEOgQtP01aNaM/RyYaleib88o6zjD0oDDISaN7nwv6F85v7FfRPEWAVZ5HUNVWxiqJqx/fEgYHpxBC3iDWcb/cexjofti/FwqOC4JRowGaGJ/n+WGl0sg1YEjULZdM759sw8VSwDDQ7Tv2H66/mSGwtP/zAGvr9tTwtfnBwpcZXssJytefriAqDsslZYTl7FzAxryo9pDioNSozLMwhCfAVm0VdIt0Ma4s0i72eUtgRnvAAq1bZK6UkE0zE8xMQjOykoiCoQLzwza+g762AQo="
}

Example Call

curl --location 'http://localhost:3000/api/v1/licenses.add' \
--header 'x-auth-token: fjiPBhtyFAn5JO3RDdDvKjkXToV2pd4_lb-nkdgJ_Q4' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ' \
--data '{
    "license":"VFJ0vHf3Jm9AR0minB342MLaHRlZdc3Du5nf0E5Sv0QJ4SUkEIaU2boCYaDsxQ2N1UL4uhLjCF9M7iCZ/yxafJjxbHvOu1D5rOfdgO4RKlAGE9tGHDidJR9crJyXVb16jPHHvLSkUFzb7HoIq/nUXxU8gEgT3uJ9u2+Dw5ukDLX3SG2AFq1hLoPSZqsP6giSOKBXTx9t8qVrT5COEn4CWCaVdApOdWC2nsROTJPJPbyjdZ9uSXQEr4raeHZXgtb9L3u2+wUej7NwDJ+C9+/6jUjmUD+CZyvpiv1YBWFudCjsgm8chrtzab70ndw1hjSXVMiuO00/wcHg8aTwZ7GSUA+OH1h1DCG4Bxrd94eZwZxEOgQtP01aNaM/RyYaleib88o6zjD0oDDISaN7nwv6F85v7FfRPEWAVZ5HUNVWxiqJqx/fEgYHpxBC3iDWcb/cexjofti/FwqOC4JRowGaGJ/n+WGl0sg1YEjULZdM759sw8VSwDDQ7Tv2H66/mSGwtP/zAGvr9tTwtfnBwpcZXssJytefriAqDsslZYTl7FzAxryo9pDioNSozLMwhCfAVm0VdIt0Ma4s0i72eUtgRnvAAq1bZK6UkE0zE8xMQjOykoiCoQLzwza+g762AQo="
}'

Example Result

Success

{
    "success": true
}

A successful response only means the license provided follows the accepted format. Check your workspace log or administration info to confirm if the license is valid and was applied to your workspace. Alternatively, you can check Confirm Enterprise License.

Error

Any of the following errors can occur on the endpoint.

• Authorization: Requires an authentication token for the request to be made.

• No permission: This occurs when the authenticated user doesn't have edit-privileged-setting permission.

Authorization

{
    "status": "error",
    "message": "You must be logged in to do this."
}

No permission

{
    "success": false,
    "error": "unauthorized"
}

Change Log

Version	Description
3.10.0	Added