Hardware Sentry TrueSight Presentation Server REST API
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://truesight.local https://{hostname}:{port}/tsws/10.0/api
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Hardware Sentry TrueSight Presentation Server REST API
| method | path | what the vendor says it does |
|---|---|---|
POST | /hardware/actions/{deviceId}/collect-now | Triggers a new collect on a specific device. You need to provide the Device ID and Monitor Class parameters to |
POST | /hardware/actions/{deviceId}/rediscover | Triggers a new discovery on a specific device. You need to provide the Device ID to identify the device:- Use |
POST | /hardware/actions/{deviceId}/reinitialize | Sends a 'Reinitialize KM' command. Launches a 'Reinitialize KM' command for the following parameters:- resetDi |
POST | /hardware/actions/{deviceId}/remove | Removes a specific instance from the monitoring environment. You need to provide the Device ID, the Monitor Cl |
POST | /hardware/actions/{deviceId}/reset-error-count | Resets the Error Count parameter. Sets the Error Count parameter to 0.You need to provide the Device ID, the M |
GET | /hardware/applications | Gets summarized information about all monitored applications. Lists all the available ApplicationSummary insta |
GET | /hardware/applications/{applicationId} | Gets detailed information for a specific application. You need to provide an Application ID:- use the hardware |
GET | /hardware/device-monitors/{deviceId} | Gets the Monitors for a specific device. You need to provide a Device ID:- use the hardware/devices service to |
GET | /hardware/devices | Gets summarized information about all monitored devices. Lists the available DeviceSummary instances.If a pare |
GET | /hardware/devices-summary | Gets overall information for all devices. Lists the GlobalSummary instance for all the monitored devices. Devi |
GET | /hardware/devices/{deviceId} | Gets detailed information about a specific device. You need to provide a Device ID:-use the hardware/devices s |
GET | /hardware/devices/{deviceId}/agent | Gets detailed information about an Agent. You need to provide a Device ID to retrieve detailed information abo |
GET | /hardware/devices/{deviceId}/agent-devices | Gets a list of all the devices monitored by an Agent. You need to provide the Device ID of a device to retriev |
GET | /hardware/devices/{deviceId}/parameter-history | Gets data history for a parameter of a specific device over a given period. You need to provide the Device ID, |
GET | /hardware/energy-usage/{deviceId} | Gets the energy usage for a specific device and a given period. You need to provide the device ID:- use the ha |
GET | /hardware/groups | Gets all group summaries. Lists the available GroupSummary instances. Groups |
GET | /hardware/groups/{groupId} | Gets detailed information about a specific group. You need to provide a Device ID:- use the hardware/groups se |
PUT | /hardware/groups/{groupId} | Updates the values of the energy footprint parameter for a specific group. You need to provide a Device ID:- u |
GET | /hardware/heating-margin-devices | Gets the heating margin values for each monitored device, when available. If a parent ID (group ID, applicatio |
GET | /hardware/history | Gets historical data for a specific group, application or service. Gets the historical data for a specific gro |
GET | /hardware/search-devices | Searches devices by name, model, manufacturer or serial number. Gets the DeviceSummary instances whose name, m |
GET | /hardware/services | Gets summarized information about all monitored services. Lists the available ServiceSummary instances. Servic |
GET | /hardware/services/{serviceId} | Gets detailed information about a specific service. You need to provide a Service ID ID :- use the hardware/se |
specification origin: https://www.sentrysoftware.com/library/mshw/11.1.00/hardware-tsps-openapi.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.