Platform
Check a licence key
Called every week by a self-hosted installation, without a token: the signed key is its own proof. Limited to 30 calls a minute.
POST
/
api
/
v1
/
licences
/
check
Check a licence key
curl --request POST \
--url https://{host}/api/v1/licences/check \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"instance": "<string>",
"domain": "<string>",
"version": "<string>"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({key: '<string>', instance: '<string>', domain: '<string>', version: '<string>'})
};
fetch('https://{host}/api/v1/licences/check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/v1/licences/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'instance' => '<string>',
'domain' => '<string>',
'version' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/api/v1/licences/check"
payload = {
"key": "<string>",
"instance": "<string>",
"domain": "<string>",
"version": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"valid": true,
"customer": "<string>",
"plan": "<string>",
"expires_at": "2023-12-25",
"expired": true
}{
"valid": true,
"reason": "revoked"
}{
"valid": true,
"reason": "invalid"
}⌘I
Check a licence key
curl --request POST \
--url https://{host}/api/v1/licences/check \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"instance": "<string>",
"domain": "<string>",
"version": "<string>"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({key: '<string>', instance: '<string>', domain: '<string>', version: '<string>'})
};
fetch('https://{host}/api/v1/licences/check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/v1/licences/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'instance' => '<string>',
'domain' => '<string>',
'version' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/api/v1/licences/check"
payload = {
"key": "<string>",
"instance": "<string>",
"domain": "<string>",
"version": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"valid": true,
"customer": "<string>",
"plan": "<string>",
"expires_at": "2023-12-25",
"expired": true
}{
"valid": true,
"reason": "revoked"
}{
"valid": true,
"reason": "invalid"
}