Appendix A: Administration Features
187
Remote Control via API
The Dominion User Station supports a remote RESTful API via HTTPS, allowing
programmed remote control to:
•
Launch Access Client sessions or Windows Layouts.
•
Perform certain administrative tasks.
•
See
API
(on page 254) for API documentation.
API Overview
•
The API can be enabled independently from the regular remote control
setting.
•
The API uses HTTPS (HTTP is not an option), listening on port 8443.
•
If remote control is enabled, the API is available only on port 8443.
•
Regular remote control cannot be used on port 8443.
•
The API is not available on regular remote control ports 80 and 443.
•
The API uses JSON documents for both POST request data (method
parameters) and responses.
•
One checkbox on the Remote Control page enables/disables the API access,
which is disabled by default.
•
The API Description document (in OpenAPI format) can be exported to a
USB drive.
•
The TLS certificate can be configured using the Server Certification setting
of the Configuration tool.
To configure Remote Control via API:
1.
Click Administration > Remote Control.
2.
Click the Edit button to enable the options.
3.
Select the Enable Remote Control via HTTPS checkbox.
4.
Select the Remote Control via API checkbox.
Export the API file to a connected USB drive. Choose a file format and
click "Export the API file".
Summary of Contents for Raritan Dominion User Station
Page 10: ......
Page 63: ...Appendix A Managing Targets and Access Methods 53 VNC Access Settings...
Page 64: ...Appendix A Managing Targets and Access Methods 54 SSH Access Settings...
Page 65: ...Appendix A Managing Targets and Access Methods 55 WEB Access Settings...
Page 159: ...Appendix A Administration Features 149 5 Enter the bind credentials in the Bind section...
Page 204: ...Appendix A Administration Features 194 9 Click Save...
Page 211: ...Appendix A Maintenance Features 201 6 Click OK in the confirmation dialog...
Page 269: ...Appendix D API 259...
Page 280: ......
