Endpoints and Install Directories (version 25)
Endpoints
The following is a list of default ports that Canary services listen on for inbound connections from other Canary services or clients. The endpoints that need opened are unique to each deployment and can be changed, if necessary, by navigating to the Endpoints screen of a particular service tile within the Canary Admin client.
| Port Number | Service | Description |
| 55310 | Licensing | (gRPC API) used by remote Canary services needing to view, add, remove, and lease a license from the License service |
| 55311 | Licensing | (REST API) used by 3rd parties to view, add, and remove licenses from the License service |
| 55273 | Admin | (gRPC) allows Canary Admin clients to connect remotely |
| 55351 | Identity | (gRPC API) used by remote Canary services to handle user authorization |
| 55353 | Identity | (REST API) used to authenticate Canary clients with OpenID Connect |
| 55282 | Historian | (gRPC API) used to add the Historian to a remote Views service |
| 55255 | Receiver | (Net.TCP) allows anonymous connection from a remote Sender service. Only needed if using Collectors older than v24. |
| 55256 | Receiver | (Net.TCP) allows secure connection from a remote Sender service. Only needed if using Collectors older than v24. |
| 55253 | Sender | (HTTP) allows clients to write data using the web API to the Historian over an anonymous connection |
| 55254 | Sender | (HTTPS) allows clients to write data using the web API to the Historian over a secure connection |
| 55291 | Store and Forward | (gRPC API) used by Canary/3rd party clients to write data to the Historian |
| 55293 | Store and Forward | (HTTPS) allows 3rd party clients using the web API to write data to the Historian |
| 55321 | Views | (gRPC API) used by Canary/3rd party clients (including the Excel Add-in) to read data from the Historian |
| 55236 | Views | (HTTPS) allows 3rd party clients using the web API to read data from the Historian |
| 55260 | ODBC | (Net.TCP) allows ODBC client connections to the ODBC service |
| 443 | Axiom | (HTTPS) allows Axiom clients to connect to the Axiom service |
Install Directories
By default, Canary uses the following three directories for its software:
- C:\Program Files\Canary - This is where Canary's executables reside.
- C:\Historian Data - This is where the actual data is stored for each DataSet. Data is stored in proprietary HDB3 files. (Only created when the Historian service is installed.)
- C:\ProgramData\Canary - This where Canary stores its program data used for its various services including Collectors, Calcs & Events, and Axiom user files.
Upon initially installing the software, the user has the option of changing these default locations.
If wishing to change these locations after the software has been installed, see How to Change the Data Historian Location and How to Change the Canary Base Path Location.
Whitelisting Canary Software
If needing to whitelist Canary's software for IT or antivirus purposes, the following directories should be included:
- C:\Historian Data
- C:\ProgramData\Canary
Note, these are the default install locations and may vary depending on your environment.
Print this page