Other formats |
Share

Using the Balabit Shell Control Box REST API

May 05, 2017


Table of Contents

1. Introduction
1.1. Message format
2. How to configure SCB using REST
3. How to configure SCB using REST — a sample transaction
4. Authenticate to the SCB REST API
5. Checking the transaction status
6. Open a transaction
7. Commit a transaction
8. Delete a transaction
9. Reviewing the changelog of a transaction
10. Application level error codes
11. Navigating the configuration of SCB
12. Modifying the configuration of SCB
12.1. Delete an object
12.2. Create a new object
12.3. Change an object
13. SCB resources reference
13.1. Retrieve basic firmware and host information
13.2. Channel policy
13.3. RDP channels
13.4. SSH channels
13.5. SSH host keys and certificates
13.6. Auditing connections
13.7. Searching in the connection database
13.8. Reporting
13.9. Reports
13.10. Built-in subchapters
13.11. Pre-defined reports
13.12. Content subchapters
13.13. Custom subchapters
13.14. Connection statistics subchapters
13.15. SSH connections
13.16. Global SSH options
13.17. SSH settings policies
13.18. SSH authentication policies
13.19. SSH connection policies
13.20. RDP connections
13.21. Configuring domain membership
13.22. Global RDP options
13.23. RDP settings policies
13.24. Telnet connections
13.25. Global Telnet options
13.26. HTTP connections
13.27. Global HTTP options
13.28. HTTP settings policies
13.29. ICA connections
13.30. Global ICA options
13.31. ICA settings policies
13.32. VNC connections
13.33. Global VNC options
13.34. Policies
13.35. Audit policies
13.36. Real-time content monitoring with Content Policies
13.37. Credential stores
13.38. LDAP servers
13.39. Signing CA policies
13.40. Ticketing policies
13.41. Time policy
13.42. Trusted Certificate Authorities
13.43. Local user databases
13.44. Usermapping policy
13.45. User lists
13.46. User management and access control
13.47. Authentication and user database settings
13.48. Privileges of usergroups
13.49. Manage users and usergroups locally on SCB
13.50. Manage usergroups locally on SCB
13.51. Manage users locally on SCB
13.52. Management options
13.53. Internal certificates
13.54. Disk fill-up prevention
13.55. Mail settings
13.56. Health monitoring
13.57. SNMP settings
13.58. SNMP traps
13.59. RPC API
13.60. Syslog server settings
13.61. Web interface
13.62. Network configuration options
13.63. DNS servers
13.64. Routing between interfaces
13.65. Naming options
13.66. Network addresses
13.67. Routing table
13.68. Local services of SCB
13.69. Local services — Web login for administrators
13.70. Local services — Web login for users
13.71. Local services — access for SNMP agents
13.72. Local services — enabling SSH access to the SCB host
13.73. Local services — configuring the indexer
13.74. Alerting
13.75. System alerts
13.76. Traffic alerts
13.77. Date & time
13.78. NTP servers
13.79. Timezone
13.80. Plug-ins
13.81. Authentication and authorization plug-ins
13.82. Credential store plug-ins
13.83. Ticketing plug-ins
13.84. Troubleshooting options
13.85. Passwords stored on SCB
13.86. Private keys stored on SCB
13.87. Certificates stored on SCB
Index