SoundBase Pro Enterprise License API

Description

This endpoint can be used to programmatically remove a license from SoundBase Pro so that it can be used again.

You must authenticate by sending the x-api-key header using your API key.

You can find your API key in the enterprise portal under the “API Docs” page.

Note:

The root URL may change in the future, so please confirm that the endpoint returns the expected values. Currently the root URL is https://my.soundbase.app

Endpoint

POST /_api/v1/clearLicenseUsage

Description

This endpoint clears the usage of a specific license associated with a machine in the system. It resets the license state so that it can be used on another machine.

Obtaining the machineId should be discussed with SoundBase developers so that it aligns with the method that SoundBase uses internally.

Request Body

Parameter	Type	Required	Description
`machineId`	String	Yes	Unique identifier for the machine.
`licenseId`	String	Yes	Unique identifier for the license.

Request Example

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

Response Codes

200 OK: License usage successfully cleared.

400 Bad Request: Invalid request due to missing parameters or incorrect data.

404 Not Found: License not found in the system.

Response Examples

Success Response (200 OK)

json
{  "message": "License usage cleared"}

Error Responses

400 Bad Request (missing parameters)

json
{  "errorCode": "INVALID_REQUEST"}

404 Not Found (license not found)

json
{  "errorCode": "LICENSE_NOT_FOUND"}

Notes

The license must exist and be associated with the specified machine.

After successful clearing, the license will be marked as not in use, with its userId, machineId, and osDetails reset.

Ensure that query parameters are properly URL-encoded when making the request.

For further assistance, contact the API support team.