The FairCom Server provides services over TCP/IP ports and shared memory. These services include APIs and browser-based applications for managing and exploring the Server.
Default FairCom Connection Strings
Protocol |
Connection String |
ISAM |
FAIRCOMS@localhost:5597 |
iSQL |
isql -u ADMIN -p ADMIN 6597@localhost:ctreeSQL |
iSQL secure |
isql -u ADMIN -p ADMIN ssl:6597@localhost:ctreesql |
JDBC |
getConnection("jdbc:ctree://localhost:6597/ctreeSQL", "ADMIN", "ADMIN") |
Python SQL |
pyctree.connect(user='ADMIN',password='ADMIN',database='ctreeSQL',host='localhost',port='6597') |
ADO.NET |
User ID=ADMIN;Password=ADMIN;database=ctreeSQL;server=localhost;port=6597 |
PHP SQL |
ctsql_connect(":6597@localhost:ctreeSQL", "ADMIN", "ADMIN") |
Default Protocols, Ports, and Names
API |
Protocol |
Port or Name |
SQL |
TCP/IP |
6597 |
JSON NAV API |
WebSocket |
8081 |
MQTT (optional) |
WebSocket |
8081 |
MQTT (primary) |
TCP/IP |
1883 |
ISAM & CTDB |
TCP/IP |
5597 |
ISAM & CTDB |
Shared Memory |
FAIRCOMS |
REST |
HTTPS over TCP/IP |
8443 |
FairCom Web Apps |
HTTPS over TCP/IP |
8443 |
Replication Manager Web App |
HTTPS over TCP/IP |
7000 |
See Also:
For example, when the FairCom Server is running and TCP/IP ports are not blocked, you can use a web browser to run the FairCom browser‑based applications and a simple REST API via https://localhost:8443 or the insecure HTTP protocol http://localhost:8080/
If a port is not working, check the following:
Tip: If the localhost domain name does not work, use the IP Address 127.0.0.1.
Use Cases for Different Ports
By default, the core database APIs (NAV, ISAM, and Low-level) are available over port 5597 using shared memory or TCP/IP. The FairCom Server automatically chooses the best protocol for these communications unless you override this behavior by changing the COMM_PROTOCOL keyword in the ctsrvr.cfg file. See Configuring Communications and Configuring Ports below.
Most programming languages support the following protocols used by FairCom Edge. The SQL API is available over port 6597, MQTT is available over port 1883, and REST over HTTPS is available over port 8443. These protocols use TCP/IP. They work well whether the application and FairCom Edge run on the same computer or on different computers. Most programming languages support these protocols.
Note: Both the REST API and the browser applications run on ports 8080 and 8443. You can connect to the browser applications using http://localhost:8080/ or https://localhost:8443. You can connect to the REST API using http://localhost:8080/ctree/api/v1/openapi or https://localhost:8443/ctree/api/v1/openapi.
Note: If a port is not working, check your firewall to make sure it is not blocked. Also check to see if another application is already using the port.