Enterprise License API

Description

This endpoint allows you to programmatically release a SoundBase Pro license so it becomes available for reuse.

Authentication requires your API key in the x-api-key header.

You can find your API key on the "API Docs" page in the enterprise portal.

The base URL (https://my.soundbase.app) may change in the future. Always verify that the endpoint returns the expected values before implementing.

Endpoint

POST /_api/v1/clearLicenseUsage

Description

This endpoint releases a license from its current machine association in the system, allowing it to be reassigned to a different machine.

Please consult with SoundBase developers about the correct method for obtaining the machineId, as it must match SoundBase's internal implementation.

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"
  }'

200 OK: License has been successfully released.

400 Bad Request: Request failed due to missing or invalid parameters.

404 Not Found: Specified license does not exist 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 be valid and currently linked to the specified machine.

Once cleared successfully, the license becomes available for reuse, and its userId, machineId, and osDetails are reset.

Remember to URL-encode all query parameters in your request.

Need help? Contact our API support team at support@showcode.co