Skip to main content

Connect Cato Networks

This guide explains how to create the Cato API key that Alerion's form asks for (Settings → Connectors → Cato Networks). Alerion reads your sites, Sockets and Internet links read-only.

Prerequisites​

  • The Editor role in the Cato Management Application (CMA): per Cato's documentation, only Editors can create or manage service API keys.
  • A Service Principal to attach the key to: an existing one (for example the automatically created "Automation Service Principal") or a new one created under Account → Administrators.
  • An Alerion plan that includes the connector (Business or above).

Create the read-only key step by step​

Steps taken from the official "Generating API Keys for the Cato API" page (see Sources):

  1. In the navigation menu, click Resources → Service API Keys.
  2. Click New: the Create API Key panel opens.
  3. Select the Service Principal associated with the key.
  4. Enter a Key Name (a label only, not used for authentication).
  5. Select Downgrade to View to limit the key to read (View) calls.
  6. Optional: under Allow access from IPs, choose Specific IP list and enter the allowed IP addresses or CIDR range (default: Any IP). Alerion's outgoing IP address is not published in this guide: ask Alerion support before restricting the key.
  7. Optional: an expiry date (Expires at). Cato recommends one for Edit keys; it is optional for a View key.
  8. Click Apply: a pop-up shows the new key. Copy it and store it securely. Once the window is closed, the key value can no longer be accessed.
  9. Click OK.

Value of each Alerion form field​

Alerion fieldValue to enter
Cato account numberThe Account ID ("unique Cato ID for your account"), shown under Account → Account Info. Alerion's form also says it appears in the console address, for example 26 in …/26/topology; Cato's documentation does not state this.
Read-only Cato API keyThe key created above, with Downgrade to View.

Alerion encrypts the key, never displays it again and never writes it to logs.

Verification​

When you submit, Alerion checks, before storing anything, that the key reads data and that its read-only nature is proven. A key that could write is refused. Nothing is saved on failure. Once connected, the connection page shows the date of the last synchronisation.

Common errors​

  • Key refused: check that the account number is the Account ID and that the key was not truncated when copied.
  • Key not read-only: recreate it with Downgrade to View selected.
  • Key restricted by IP: if Alerion's outgoing IP is not in the list, Cato refuses the calls; switch back to Any IP or add the address provided by support.
  • Lost key: the value is no longer accessible, create a new one.

Sources​