Hardware Sentry TrueSight Presentation Server REST API
Hardware Sentry TrueSight Presentation Server REST API
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Hardware Sentry TrueSight Presentation Server REST API
Endpoints 23
Actions
- POSTTriggers a new collect on a specific device.
/hardware/actions/:deviceId/collect-now?monitorClass=MS_HW_FANYou need to provide the <b>Device ID</b> and <b>Monitor Class</b> parameters to identify the device:<br>- Use the <b>/hardware/devices</b> service in the… - POSTTriggers a new discovery on a specific device.
/hardware/actions/:deviceId/rediscoverYou need to provide the <b>Device ID</b> to identify the device:<br>- Use the <b>/hardware/devices</b> service in the <b>Device</b> section to retrieve the… - POSTSends a 'Reinitialize KM' command.
/hardware/actions/:deviceId/reinitializeLaunches a 'Reinitialize KM' command for the following parameters:<br>- resetDiscoveryAndPollingIntervals<br>- resetAlertAfterNTimes<br>-… - POSTRemoves a specific instance from the monitoring environment.
/hardware/actions/:deviceId/remove?monitorClass=MS_HW_FAN&monitorSid=cisco-c240-imcYou need to provide the <b>Device ID</b>, the <b>Monitor Class</b> and the <b>Monitor SID</b> parameters:<br>- Use the <b>/hardware/devices</b> service in the… - POSTResets the Error Count parameter.
/hardware/actions/:deviceId/reset-error-count?monitorClass=MS_HW_FAN&monitorSid=cisco-c240-imcSets the Error Count parameter to 0.<br><br>You need to provide the <b>Device ID</b>, the <b>Monitor Class</b> and the <b>Monitor SID</b> parameters:<br>- Use…
Applications
- GETGets summarized information about all monitored applications.
/hardware/applications?page=0&limit=100&direction=asc&sort=nameLists all the available ApplicationSummary instances. - GETGets detailed information for a specific application.
/hardware/applications/:applicationIdYou need to provide an <b>Application ID</b>:<br>- use the <b>hardware/applications</b> service to retrieve all available application IDs.
Devices
- GETGets the Monitors for a specific device.
/hardware/device-monitors/:deviceIdYou need to provide a <b>Device ID</b>:<br>- use the <b>hardware/devices</b> service to get all available device IDs. - GETGets summarized information about all monitored devices.
/hardware/devices?page=0&limit=100&direction=asc&sort=name&groupId=0&applicationId=0&serviceId=0Lists the available DeviceSummary instances.<br><br>If a parent ID (group ID, application ID, or service ID) is provided, the function narrows down the… - GETGets overall information for all devices.
/hardware/devices-summaryLists the GlobalSummary instance for all the monitored devices. - GETGets detailed information about a specific device.
/hardware/devices/:deviceIdYou need to provide a <b>Device ID</b>:<br>-use the <b>hardware/devices</b> service to get all available device IDs. - GETGets detailed information about an Agent.
/hardware/devices/:deviceId/agentYou need to provide a <b>Device ID</b> to retrieve detailed information about the Agent that Monitors the device:<br>-use the <b>hardware/devices</b> service… - GETGets a list of all the devices monitored by an Agent.
/hardware/devices/:deviceId/agent-devicesYou need to provide the <b>Device ID</b> of a device to retrieve any other devices monitored by the same Agent:<br>-use the <b>hardware/devices</b> service to… - GETGets data history for a parameter of a specific device over a given period.
/hardware/devices/:deviceId/parameter-history?parameterName=Power Consumption&monitorType=_PATROL__MS_HW_REPORT&from=1608850800&to=1608850800&monitorSid=cisco-c240-imcYou need to provide the <b>Device ID</b>, <b>Parameter Name</b>, <b>Monitor Type</b> and <b>Monitor SID</b>:<br>- use the <b>hardware/devices</b> service to… - GETGets the energy usage for a specific device and a given period.
/hardware/energy-usage/:deviceId?rollPeriod=ONE_DAY&basis=HOURLYYou need to provide the device ID:<br>- use the <b>hardware/devices</b> service to get all available device IDs. - GETGets the heating margin values for each monitored device, when available.
/hardware/heating-margin-devices?covered=true&page=0&limit=100&direction=asc&sort=name&groupId=0&applicationId=0&serviceId=0If a parent ID (group ID, application ID, or service ID) is provided, the function narrows down the devices list to those attached to the specified… - GETSearches devices by name, model, manufacturer or serial number.
/hardware/search-devices?searchTerms=EMC Unity&groupId=0&applicationId=0&serviceId=0&page=0&limit=100Gets the DeviceSummary instances whose name, model, manufacturer or serial number match the specified criteria.<br><br>If a parent ID (group ID, application…
Groups
- GETGets all group summaries.
/hardware/groups?page=0&limit=100&direction=asc&sort=nameLists the available GroupSummary instances. - GETGets detailed information about a specific group.
/hardware/groups/:groupIdYou need to provide a <b>Device ID</b>:<br>- use the <b>hardware/groups</b> service to get all available group ID. - PUTUpdates the values of the energy footprint parameter for a specific group.
/hardware/groups/:groupIdYou need to provide a <b>Device ID</b>:<br>- use the <b>hardware/groups</b> service to get all available group ID.<br><br>If the ID is <em>"global"</em>, then…
Historical Data
- GETGets historical data for a specific group, application or service.
/hardware/history?groupId=0&applicationId=0&serviceId=0&from=1608850800&to=1608850800Gets the historical data for a specific group, application or service, for a given period.<br><br>If a parent ID (group ID, application ID, or service ID) is…
Services
- GETGets summarized information about all monitored services.
/hardware/services?page=0&limit=100&direction=asc&sort=nameLists the available ServiceSummary instances. - GETGets detailed information about a specific service.
/hardware/services/:serviceIdYou need to provide a <b>Service ID</b> ID :<br>- use the <b>hardware/services</b> service to get all available service IDs.
API details
- Base URL
http://truesight.localhttps://{hostname}:{port}/tsws/10.0/api- Authentication
- An API key in the Cookie header
- Operations
- 23 operations on 22 pathsGET 17POST 5PUT 1
- Main resources
- Devices 10Actions 5Groups 3Applications 2Services 2Historical Data 1
- Response formats
*/*- Description format
- OpenAPI 3.0.1, API version
11.1.00 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Hardware Sentry TrueSight Presentation Server REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Hardware Sentry TrueSight Presentation Server REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Cookie header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Triggers a new collect on a specific device.” (POST /hardware/actions/:deviceId/collect-now?monitorClass=MS_HW_FAN), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Hardware Sentry TrueSight Presentation Server REST API?
Hardware Sentry TrueSight Presentation Server REST API It is listed under IoT & devices and has 23 endpoints.
Who publishes the Hardware Sentry TrueSight Presentation Server REST API?
It is listed from Truesight's public API description (an OpenAPI document), not published by Truesight on Swastik Codes. Anyone who controls its domain can claim the profile by adding a DNS TXT record.
What is the base URL of the Hardware Sentry TrueSight Presentation Server REST API?
Its description lists 2 base URLs: http://truesight.local, https://{hostname}:{port}/tsws/10.0/api. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Hardware Sentry TrueSight Presentation Server REST API?
With an API key in the Cookie header.
How many endpoints does the Hardware Sentry TrueSight Presentation Server REST API have?
23 operations on 22 paths (17 GET, 5 POST, 1 PUT). The largest groups are Devices, Actions, Groups, Applications.
Is forking the Hardware Sentry TrueSight Presentation Server REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.