Read-only APIs

Splashtop now supports read-only APIs. When creating an API token through the Splashtop web console, you can choose to restrict it to read-only access, allowing you to safely share or use tokens for reporting, monitoring, and integrations without risk of modifying data.

Supported Subscriptions

  • Splashtop Enterprise [Remote Support (Technician) | Remote Access (End-User)]

Creating a Read-Only API Token

  1. Log into the Splashtop web console (Global / EU / OC).
  2. Go to Account Settings > Web API Tokens > Manage.
  3. Create or Edit API token.
  4. Toggle Read Only to restrict the token to read-only access.
Readonly.png

Once enabled, the token can only be used to call the APIs listed below. Any attempt to call a write, update, or delete API with a read-only token will be rejected.

Available Read-Only APIs

The following APIs are accessible using a read-only API token.

Computers

API Method
Computer list GET
Inventory POST
Computer tag list GET
Tag details GET
Computer list associated to a tag GET
Tag association for specified computers POST

Users

API Method
User list GET
SSO methods information GET
Granular control status information GET
Granular control admin configurable status information GET

Groups

API Method
Group information GET
Group's users GET
Group's associates GET
Group's computers GET
Group's admin info in a team GET
Group's admin info in a group GET

Remote Access

API Method
User's access permissions GET
Group's access permissions GET
Scheduled access – team's scheduled access list GET
Scheduled access – scheduled access details GET
Scheduled access – current user's all scheduled access GET
Scheduled access – list of computers and groups for a scheduled access GET
Scheduled access – scheduled access timeslot list GET
Scheduled access – access schedule timeslot details GET

Logs

API Method
Team history GET
Session logs POST
Details of session events GET
File transfer logs GET
Chat transcript logs GET
Alerts GET
Endpoint security logs GET
One to many logs GET
Windows updates Logs GET
Service desk operations logs GET

Attended Support

API Method
Query channel list GET
Query info of existing support session GET
Query support session in a channel GET
Retrieve session logs GET
Retrieve file transfer logs GET
Retrieve download links for chat logs GET
Retrieve transcript logs GET

Endpoint Management

API Method
Endpoint management policy list GET
List computers in a policy POST
List groups in a policy POST
Windows OS patch opportunities list POST
Mac OS patch opportunities list POST
Query vulnerabilities and OS versions GET

Notes

  • Read-only APIs cannot be used to create, update, or delete any resource (users, computers, groups, labels, sessions, etc.), even if the underlying API would normally allow it.
  • Over time, Splashtop will continue to expand the list of supported read-only APIs. See What we're working on next (Roadmap) for more details.
  • For general API setup, authentication, and the full API reference, see Splashtop Open APIs.

0 out of 0 found this helpful