Other formats |
Share

Using the Balabit Shell Control Box REST API

January 05, 2017


Table of Contents

1. Introduction
1.1. Message format
1.2. How to configure SCB using REST
1.3. How to configure SCB using REST — a sample transaction
2. Using the SCB REST API
2.1. Authenticate to the SCB REST API
2.2. Checking the transaction status
2.3. Open a transaction
2.4. Commit a transaction
2.5. Delete a transaction
2.6. Reviewing the changelog of a transaction
2.7. Application level error codes
2.8. Navigating the configuration of SCB
2.9. Modifying the configuration of SCB
2.9.1. Delete an object
2.9.2. Create a new object
2.9.3. Change an object
3. Basic settings
3.1. Retrieve basic firmware and host information
3.2. Network settings
3.2.1. Web interface
3.2.2. Network configuration options
3.2.3. DNS servers
3.2.4. Routing between interfaces
3.2.5. Naming options
3.2.6. Network addresses
3.2.7. Routing table
3.2.8. Local services of SCB
3.2.9. Local services — Web login for administrators
3.2.10. Local services — Web login for users
3.3. Date and time
3.3.1. Date & time
3.3.2. NTP servers
3.3.3. Timezone
3.4. Logs, monitoring and alerts
3.4.1. Management options
3.4.2. Syslog server settings
3.4.3. Disk fill-up prevention
3.4.4. Mail settings
3.4.5. Health monitoring
3.4.6. SNMP settings
3.4.7. SNMP traps
3.4.8. Local services — access for SNMP agents
3.4.9. Alerting
3.4.10. System alerts
3.4.11. Traffic alerts
4. User management and access control
4.1. User management and access control
4.2. Authentication and user database settings
4.3. Privileges of usergroups
4.4. Manage users and usergroups locally on SCB
4.5. Manage usergroups locally on SCB
4.6. Manage users locally on SCB
5. Managing SCB
5.1. Troubleshooting options
5.2. Internal certificates
5.3. Passwords stored on SCB
5.4. Private keys stored on SCB
5.5. Certificates stored on SCB
5.6. Local services — enabling SSH access to the SCB host
5.7. RPC API
6. General connection settings
6.1. Channel policy
6.2. Policies
6.3. Audit policies
6.4. Real-time content monitoring with Content Policies
6.5. LDAP servers
6.6. Signing CA policies
6.7. Time policy
6.8. Trusted Certificate Authorities
6.9. Local user databases
6.10. User lists
7. HTTP connections
7.1. HTTP connections
7.2. Global HTTP options
7.3. HTTP settings policies
8. Citrix ICA connections
8.1. ICA connections
8.2. Global ICA options
8.3. ICA settings policies
9. RDP connections
9.1. RDP connections
9.2. RDP channels
9.3. Configuring domain membership
9.4. Global RDP options
9.5. RDP settings policies
10. SSH connections
10.1. SSH connections
10.2. SSH connection policies
10.3. SSH channels
10.4. SSH authentication policies
10.5. Global SSH options
10.6. SSH settings policies
10.7. SSH host keys and certificates
11. Telnet connections
11.1. Telnet connections
11.2. Global Telnet options
12. VNC connections
12.1. VNC connections
12.2. Global VNC options
13. Searching and indexing sessions
13.1. Auditing connections
13.2. Searching in the connection database
13.3. Local services — configuring the indexer
13.4. Indexer policies
14. Reporting
14.1. Reporting
14.2. Reports
14.3. Built-in subchapters
14.4. Pre-defined reports
14.5. Content subchapters
14.6. Custom subchapters
14.7. Connection statistics subchapters
15. Advanced authentication and authorization
15.1. Usermapping policy
15.2. Plugins
15.3. Authentication and authorization plugins
15.4. Credential store plugins
15.5. Credential stores
15.6. Ticketing policies
15.7. Ticketing plugins
List of SCB REST API parameters and elements