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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/partner/license/getClaimKeyByCode
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

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.

Request body

claimCodestring nullable

Response

OK

Example response

{
  "claimKey": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.