Preview a claim key for the MSP pool
curl --request POST \
--url https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"claimCode": "<string>"
}
'import requests
url = "https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode"
payload = { "claimCode": "<string>" }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({claimCode: '<string>'})
};
fetch('https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"claimCode\": \"<string>\"\n}")
.asString();{
"claimKey": {
"claimEndDate": "2023-11-07T05:31:56Z",
"claimStartDate": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"expirationEmailState": "NINETY_DAY_EMAIL_SUCCEEDED",
"gracePeriodEndDate": "2023-11-07T05:31:56Z",
"maskedClaimCode": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"requestId": "<string>",
"returnHistory": [
{
"returnedProductQuantities": {},
"timestamp": "2023-11-07T05:31:56Z"
}
],
"state": "CREATED",
"trial": true,
"type": "NEW",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Partner Webservice
Preview a claim key for the MSP pool
MSP only. Looks up a claim key by code before claiming it into the pool. Same visibility rule as the customer-console getClaimKeyByCode: an unclaimed key, or one already claimed by the calling MSP org; a key claimed by any other org is refused.
POST
/
api
/
partner
/
license
/
getClaimKeyByCode
Preview a claim key for the MSP pool
curl --request POST \
--url https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"claimCode": "<string>"
}
'import requests
url = "https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode"
payload = { "claimCode": "<string>" }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({claimCode: '<string>'})
};
fetch('https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"claimCode\": \"<string>\"\n}")
.asString();{
"claimKey": {
"claimEndDate": "2023-11-07T05:31:56Z",
"claimStartDate": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"expirationEmailState": "NINETY_DAY_EMAIL_SUCCEEDED",
"gracePeriodEndDate": "2023-11-07T05:31:56Z",
"maskedClaimCode": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"requestId": "<string>",
"returnHistory": [
{
"returnedProductQuantities": {},
"timestamp": "2023-11-07T05:31:56Z"
}
],
"state": "CREATED",
"trial": true,
"type": "NEW",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
Response
200 - application/json
OK
Show child attributes
Show child attributes
Last modified on September 22, 2026