POST/v1/license/activatePOST /v1/license/activate
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/activate \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/activate
Body parameter
{
"userKey": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.ActivateLicenseRequest | false | none |
Example responses
200 Response
{"success":true,"licenseToken":"string","tokenExpireAt":{"seconds":0,"nanos":0},"activeClientCount":0,"maxClientCount":0,"license":{"licenseId":"string","licensingMode":0,"expireAt":{"seconds":0,"nanos":0},"supportExpireAt":{"seconds":0,"nanos":0},"licenseKey":[0]}}{
"success": true,
"licenseToken": "string",
"tokenExpireAt": {
"seconds": 0,
"nanos": 0
},
"activeClientCount": 0,
"maxClientCount": 0,
"license": {
"licenseId": "string",
"licensingMode": 0,
"expireAt": {
"seconds": 0,
"nanos": 0
},
"supportExpireAt": {
"seconds": 0,
"nanos": 0
},
"licenseKey": [
0
]
}
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.ActivateLicenseResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey
POST/v1/license/deactivatePOST /v1/license/deactivate
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/deactivate \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/deactivate
Body parameter
{
"userKey": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.DeactivateLicenseRequest | false | none |
Example responses
200 Response
{"licenseId":"string","activeClientCount":0,"maxClientCount":0}{
"licenseId": "string",
"activeClientCount": 0,
"maxClientCount": 0
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.DeactivateLicenseResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey
POST/v1/license/requestPOST /v1/license/request
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/request \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/request
Body parameter
{
"userKey": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.RequestLicenseRequest | false | none |
Example responses
200 Response
{"granted":true,"licenseToken":"string","tokenExpireAt":{"seconds":0,"nanos":0},"heartbeatInterval":{"seconds":0,"nanos":0},"activeClientCount":0,"maxClientCount":0,"license":{"licenseId":"string","licensingMode":0,"expireAt":{"seconds":0,"nanos":0},"supportExpireAt":{"seconds":0,"nanos":0},"licenseKey":[0]}}{
"granted": true,
"licenseToken": "string",
"tokenExpireAt": {
"seconds": 0,
"nanos": 0
},
"heartbeatInterval": {
"seconds": 0,
"nanos": 0
},
"activeClientCount": 0,
"maxClientCount": 0,
"license": {
"licenseId": "string",
"licensingMode": 0,
"expireAt": {
"seconds": 0,
"nanos": 0
},
"supportExpireAt": {
"seconds": 0,
"nanos": 0
},
"licenseKey": [
0
]
}
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.RequestLicenseResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey
POST/v1/license/releasePOST /v1/license/release
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/release \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/release
Body parameter
{
"licenseToken": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.ReleaseLicenseRequest | false | none |
Example responses
200 Response
{"licenseId":"string","activeClientCount":0,"maxClientCount":0}{
"licenseId": "string",
"activeClientCount": 0,
"maxClientCount": 0
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.ReleaseLicenseResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey
POST/v1/license/heartbeatPOST /v1/license/heartbeat
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/heartbeat \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/heartbeat
Body parameter
{
"licenseToken": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.HeartbeatRequest | false | none |
Example responses
200 Response
{"active":true,"activeClientCount":0,"maxClientCount":0,"tokenExpireAt":{"seconds":0,"nanos":0},"heartbeatInterval":{"seconds":0,"nanos":0}}{
"active": true,
"activeClientCount": 0,
"maxClientCount": 0,
"tokenExpireAt": {
"seconds": 0,
"nanos": 0
},
"heartbeatInterval": {
"seconds": 0,
"nanos": 0
}
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.HeartbeatResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey
POST/v1/license/validatePOST /v1/license/validate
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/validate \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/validate
Body parameter
{
"userKey": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.ValidateLicenseRequest | false | none |
Example responses
200 Response
{"success":true,"licenseToken":"string","tokenExpireAt":{"seconds":0,"nanos":0},"activeClientCount":0,"maxClientCount":0,"license":{"licenseId":"string","licensingMode":0,"expireAt":{"seconds":0,"nanos":0},"supportExpireAt":{"seconds":0,"nanos":0},"licenseKey":[0]}}{
"success": true,
"licenseToken": "string",
"tokenExpireAt": {
"seconds": 0,
"nanos": 0
},
"activeClientCount": 0,
"maxClientCount": 0,
"license": {
"licenseId": "string",
"licensingMode": 0,
"expireAt": {
"seconds": 0,
"nanos": 0
},
"supportExpireAt": {
"seconds": 0,
"nanos": 0
},
"licenseKey": [
0
]
}
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.ValidateLicenseResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey
POST/v1/license/infoPOST /v1/license/info
Code samples
cURL
# You can also use wget
curl -X POST /v1/license/info \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/license/info
Body parameter
{
"userKey": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string"
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Licensing.LicenseInfoRequest | false | none |
Example responses
200 Response
{"licenseTokens":[{"token":"string","licenseId":"string","revoked":true,"clientId":"string","clientAddr":"string","clientName":"string","machineId":"string","issuedAt":{"seconds":0,"nanos":0},"expireAt":{"seconds":0,"nanos":0},"lastHearbeat":{"seconds":0,"nanos":0}}],"licenseId":"string","maxClientCount":0,"activeClientCount":0,"licensingMode":0,"revoked":true,"issuedAt":{"seconds":0,"nanos":0},"expireAt":{"seconds":0,"nanos":0},"supportExpireAt":{"seconds":0,"nanos":0}}{
"licenseTokens": [
{
"token": "string",
"licenseId": "string",
"revoked": true,
"clientId": "string",
"clientAddr": "string",
"clientName": "string",
"machineId": "string",
"issuedAt": {
"seconds": 0,
"nanos": 0
},
"expireAt": {
"seconds": 0,
"nanos": 0
},
"lastHearbeat": {
"seconds": 0,
"nanos": 0
}
}
],
"licenseId": "string",
"maxClientCount": 0,
"activeClientCount": 0,
"licensingMode": 0,
"revoked": true,
"issuedAt": {
"seconds": 0,
"nanos": 0
},
"expireAt": {
"seconds": 0,
"nanos": 0
},
"supportExpireAt": {
"seconds": 0,
"nanos": 0
}
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Licensing.LicenseInfoResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey