Skip to content
SoundBaseSoundBaseSoundBase

Enterprise License API

Programmatically release SoundBase Desktop licenses from their machines so they can be reused — one endpoint, authenticated with your enterprise API key.

Typical use: an MDM or provisioning script frees the license when a machine is wiped or reassigned, without anyone opening the enterprise portal.

Authentication

Section titled “Authentication”

Pass your API key in the x-api-key header. You’ll find (and can regenerate or revoke) your key on the API Docs page of the enterprise portal.

  • One key per enterprise account. Regenerating replaces the old key immediately.
  • This API is designed for server-to-server use — browsers can’t call it cross-origin.

Release a license

Section titled “Release a license”
POST https://my.soundbase.app/_api/v1/clear-license-usage

Releases a license from its current machine association, allowing it to be activated on a different machine.

Request body (JSON — parameters must be in the body, not the query string):

Parameter Type Required Description
machineId String Yes The machine currently holding the license. Must match SoundBase’s internal machine identifier — consult SoundBase support about obtaining it.
licenseId String Yes The license identifier.

Example

Terminal window
curl -X POST https://my.soundbase.app/_api/v1/clear-license-usage \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -d '{
    "machineId": "YOUR_MACHINE_ID_HERE",
    "licenseId": "YOUR_LICENSE_ID_HERE"
  }'

Responses

Section titled “Responses”
Status Body Meaning
200 {"message": "License usage cleared for <machineId>", "action": "reset"} The license was released; its user, machine, and OS details are reset and it’s ready for reuse.
200 {"message": "CLAIR license deleted for <machineId>", "action": "deleted"} The identifier referred to a CLAIR-managed child license; releasing it removes the child entry entirely.
400 {"errorCode": "INVALID_REQUEST"} machineId or licenseId missing from the body.
400 {"errorCode": "LICENSE_NOT_FOUND"} The license isn’t an enterprise-managed license.
401 {"errorCode": "UNAUTHORIZED"} Missing or invalid x-api-key.
404 {"errorCode": "LICENSE_NOT_FOUND"} No license matches that licenseId/machineId pair.

Every successful release is recorded in the license history visible in the enterprise portal.

Section titled “Related”
  • License manager guides — activating and deactivating user-based licenses in the app
  • Live Report API — read-only JSON access to published coordination reports (a separate API with its own tokens)