Skip to main content

Activate License

POST /public/v1/license/activate

Activates the Portal setup using a Response Code obtained from Xeotek Link.


Request

Body Parameters

FieldTypeDescriptionRequired
responsestringResponse Code from Xeotek LinkYes

Example Request

curl --location --request POST 'https://your-instance.com/public/v1/license/activate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your-api-key>' \
--data-raw '{
"response": "<response-code>"
}'

Response

Example Successful Response

{
"status": "success"
}

HTTP Status Code: 200 OK


Example Error Response

{
"status": "error",
"message": "Invalid or expired response code."
}

HTTP Status Code:

  • 400 Bad Request — Error activating the license
  • 401 Unauthorized — Invalid API key

Best Practices

  • Always store the database persistently after activation. The license is tied to the database.
  • Ensure the Challenge and Response Codes are transferred securely to prevent tampering.
  • Decommission any previous setup before activating a new environment with the same license to avoid under-licensing.