Sentinel Up APIs
Base URL
The Sentinel Up API utilizes the HTTPS GET method, with the base URL configured as https://up.sentinelcloud.com/api.
Request Parameters
|
Parameter |
Description |
Required |
Values |
|---|---|---|---|
|
key |
Unique identifier for your Sentinel Up account. |
Required |
For example: 40778acd9f5d5d19e621fb950061ba7c |
|
id |
Unique identifier for the requesting client. This identifier must be distinct for each device, particularly after OS re-installation or a reset to factory settings. |
Required |
For example: 09c9bcdc-b9a9-999f-9999-bb09fae09999 |
|
productCode |
Unique identifier for your product. |
Required (in combination with productVersion) |
For example: 07c5bcdc-b3a6-482f-8556-bb04fae06538 |
|
productVersion |
Current installed version of your product, typically in the format aaaa.bbbb.cccc.dddd. |
Required (in combination with productCode) |
For example: > 1.2 > 2.4.1.1234 > 4 0.6.1 |
|
versionCode |
Unique identifier for your currently installed product version, uniquely identifying your product's version. |
Required (without productCode & productVersion combination) |
For example: 08c8bcdc-b8a8-888f-8888-bb08fae08888 |
|
format |
Output format to return: XML, or JSON. |
Optional |
Valid values: > xml (default) > json |
|
os |
Operating system performing the request |
Optional |
For example: > Windows 6.2 >Windows XP > Linux 2.16 > Mac OS X 10.7 > Android 2.2.2 |
|
arch |
Device architecture. |
Optional |
For example: > x64 >32 Bit > x86-64 |
|
lang |
Requested language based on ISO 639-1 definition. Codes for the representation of language names (e.g., de-DE will be transformed into de). |
Optional |
For example: > en >de > pl |
|
test |
Enables you to access updates/messages marked as 'In test.' Note: The test key expires or changes monthly.
|
Optional |
For example: 40778acd9f5d5d19e621fb950061ba7c |
|
custom |
Enables you to set a custom filter for your updates or messages. |
Optional |
For example: NoServer Special ID driver version |
|
ident |
Custom identifier for a better review of your clients. |
Optional |
For example: E-Mail Address Vendor ID Username |
Request Limit
There is a defined limit on the number of requests a client can make, and it is determined by the client id.
The limit is as follows:
30 requests per hour
For development and testing purposes, please use your test key, which has a limit of 90 requests per hour.