Partner Webservice

Claim licenses into the MSP pool

MSP only. Claims a key into the MSP's own org with the MSP recorded as owner, so the licenses can later be assigned to managed clients.

post/api/partner/license/claimToPool

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/partner/license/claimToPool
  • 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

claimKeyUuidstring RUUID nullable

base 64 (url-safe) uuid string

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "claimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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