Partner Webservice

Reclaim pool licenses from a managed client

MSP only. Moves MSP-owned licenses held by a managed client back to the pool, optionally unassigning them from devices first. Idempotent by requestId.

post/api/partner/license/reclaimFromClient

Request

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

clientOrgUuidstring RUUID nullable

base 64 (url-safe) uuid string

forceUnassignboolean nullable

When true, device-assigned licenses are unassigned first (config downgrade included).

licenseUuidsstring[] nullable

Explicit licenses; or use productCode + quantity.

productCodestring nullable
quantityinteger nullable
requestIdstring nullable

Idempotency key; retries with the same id are safe.

Example request

{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "licenseUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Response

OK

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
reclaimedstring[] nullable
unassignedDevicesstring[] nullable

Devices whose license was force-unassigned by this call.

warningMsgstring nullable

Example response

{
  "reclaimed": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "skipped": [
    {
      "licenseUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "unassignedDevices": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Changes

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