LiveBoost API
What is LiveBoost?
When you activate Counterspy countermeasures against a high-risk application instance, the instance’s reaction time depends on how often it connects to Counterspy: its call-home frequency.
For premium live content, preventing loss means disrupting a pirate’s activity quickly during the live event.
LiveBoost gives you the ability to temporarily increase the call-home frequency of app instances so that your countermeasures take effect faster.
LiveBoost is available through a REST API only.
To Use LiveBoost
- Retrieve an authorization token for your REST request
- Create a request using your authorization token in the header and the LiveBoost configuration change details in the body
- Make the request to the LiveBoost API
LiveBoost Pricing
Each use of LiveBoost is charged when the LiveBoost configuration change starts. LiveBoost charges are in addition to your Counterspy subscription and are invoiced with your regular billing cycle.
LiveBoost charges depend on your selected call-home frequency and the duration of the LiveBoost session. For more information, contact Verimatrix.
Retrieving an Authorization Token
Before creating a LiveBoost request through the REST interface, you need to retrieve an authorization token from the Verimatrix Platform UI.
To Retrieve an Authorization Token
-
In a web browser, go to the Verimatrix Platform login page.
-
Open the browser’s web developer tools panel. On Firefox, Chrome, and Edge, the keyboard shortcut is Ctrl+Alt+I (or ⌘⌥ I on Mac).
-
In the web developer tools panel, select the Network tab.
For example, in an Edge browser: -
Enter your login name and password and then click Sign In.
-
Filter the Network panel for the authentication POST request to https://ssoapi-ng.platform.verimatrixcloud.net/v1/auth:
-
In Chrome and Edge, filter by method:POST
For example, in an Edge browser: -
In Firefox, filter by POST
-
View the authorization request response.
For example, in Edge, select the request and then select the Response tab: -
The request’s response contains a “token” field. This is your authorization token. For example:
"IiV3FU1E4SLvZRmFAbM71uLLJeLB6TAsI8m+xDgF1R0HSGEibWI4FaqoRJ2He081L+Zx9cho/sIDlhpr4mog3fdtJ/DBGYin48skIJepXapkeJhI2W
/R71313YBd0+nd1AAUqYhUWCycbB9tAyfa4RuU6DQkTTarxSQjQfU+Y2qQWzvCHg4P521Xzv/nWZhnJvV4+kgumeU4Gkmt6iodIe9OVLkkrS6vNiPI/9a5yXb
L2D3KwDw0GwRTouOQliWySltIWE/oBMYTs9lbUilqaiPI9mB81vedlxfvsvAVBs4BapqcqiNZXN2oVwyysdV0DFJGRGXw+eqzdSg129muQG6BDOeF8eIpywQxOqinz1FEynFXpv8kggJi/CHnWkIN6yaQK08U3Ji4MohqOCJmaOfHKlfXpl1S2R2uh0xqBqqUcZA8bU3ClKT5WSfTUqnb6NqQUI3pYig9ZBLnDW8TpUVMo7Y9e/7neukYOiurQxUqx1OyuAXfYVATHo4iBb6…lDcvq9IHVzG3/fmeE85VXQ60HlIHsPLuAxuVL+DOHbNJ/1TTqYCu7g1gg8aLNPfaZeRnQI9qpq6sQw6/KiPddzENbe3DR8EGo4BWDi/MJD2fcE2QaTt+w6Klvar8ZnrEHsAJDNwsrPb6GEvDK1S8hw1UtjsWTujVkAMoS3qo+3HPJws6huBf2ic+y7jvAPa5Qq5aTgIO+eOA0eb2w6/wZBpKQ8KIV29Cfax+hl8TSC5bOyPh6nqCwaqlFXzcjGRSCnUSL8ycjVk2Q3gv1E076upL0pF3zAlBRTmL0WPWDsFc3i9st8hpWfcn1U5zjusuNrXHDJlKFJIV7Y4o34hQdnaG2YooveSvS3j5dWUlYLcIhPVhgy0bqC0AkVljZNtgHBpHEgBKc1YAjcVjayUP9f/WFVtis+fV+7ePSi6F6dmG/E75lZQv6T8kR6dd5Ugl30L+tRxu8b4D22dMi+Dz5aCCf6jmYXiED+FqfCO0CkZVJ+RG3Eli86okx+bug="
NOTE Your authorization token lasts only as long as your Platform session. On expiry, you must retrieve a new token from the Platform UI to create a valid LiveBoost request.
How to use LiveBoost
Create LiveBoost requests through the REST interface.
Activate LiveBoost by calling the LiveBoost API with:
Header:
- A valid authorization token in the header
Body:
- Start date and time of the configuration change
- Duration of the configuration change (4, 8, or 24 hours)
- Call-home frequency (every 30, 60, 300, or 600 seconds)
- App identifier for applying the LiveBoost configuration
- Event name, such as the name of the premium content that you plan to stream during the LiveBoost
LiveBoost API
The LiveBoost API creates a future-dated LiveBoost configuration change that temporarily modifies the call-home frequency of an application.
Servers
https://reveal-api-v2.watermarking.eu1.verimatrixcloud.net
Request
PATCH /v2/application/{id}/call-home-frequency/
Request Parameters
Name | Type | Description |
---|---|---|
id | string | The application or package identifier |
Header Example
"authorization": "Bearer {token}"
Header Parameters
Name | Type | Description |
---|---|---|
token | string | The authorization token that you retrieved when logging in. If you do not have a valid token, then refer to section “Retrieving an Authorization Token". |
Request Body Example
"packageId": "com.acme.myapp",
"eventName": "France-Brazil FIFA U-17 World Cup final",
"startTimestamp": "2025-08-20T09:15:13.000Z",
"periodInSeconds": 300,
"durationInHours": 4
}
Request Body Parameters
Name | Type | Description |
---|---|---|
packageId | string | The application or package identifier |
eventName | string | Short description of the event that the LiveBoost covers |
startTimestamp | string | The start date and time of the LiveBoost configuration change in ISO 8601 format Example: 2025-09-27T18:00:00.000Z |
periodInSeconds | integer | The LiveBoost call-home frequency Units: Seconds Valid values: 30 60 300 600 |
durationInHours | integer | The duration of the LiveBoost |
Response
Code | Description |
---|---|
200 | Success |
400 | Invalid ID parameter |
401 | Unauthenticated. Access is forbidden for unauthenticated requests |
403 | Forbidden. You are not authorized to access the resource |
500 | Server error |
Updated 16 days ago