Cato Networks GraphQL API CLI
catocli is a command-line client for the
Cato Networks GraphQL API.
It supports interactive use and automation for querying, reporting, and
managing Cato account configuration.
Use it to:
- Query network, security, user, and application data
- Manage supported Cato configuration through GraphQL mutations
- Export results as JSON or CSV
- Automate workflows with profiles, files, and command-line overrides
Requirements
- Python 3.10 or newer (tested with Python 3.10 through 3.14)
- A Cato API token and account ID
See Generating API Keys for the Cato API for token setup.
Installation
python3 -m pip install --upgrade catocli
catocli --version
Quick start
Configure the default profile:
# Interactive setup
catocli configure set
# Or non-interactive setup
catocli configure set --cato-token "your-api-token" --account-id "12345"
Run a query:
catocli query entityLookup '{"type":"country"}'
Inspect available commands and operation-specific arguments:
catocli --help
catocli query --help
catocli query entityLookup --help
Credentials are stored in the local profile configuration. Do not place API tokens in source files, shell history, or committed scripts. See Profile Management for named profiles and environment selection.
Configuration
# List profiles
catocli configure list
# Show the active profile
catocli configure show
# Select a profile
catocli configure use prod
# Override the configured account for one operation
catocli query entityLookup -accountID 12345 '{"type":"country"}'
For shell completion setup, see Tab Completion.
JSON input
Pass variables inline or load them from a file:
catocli query site networkRangeList \
'{"networkRangeListInput":{"site":{"by":"ID","input":"527548"}}}'
catocli query site networkRangeList \
--json-file query.site.networkRangeList.json
Operation help includes a generated input example:
catocli query site networkRangeList --help
Run from source
git clone https://github.com/Cato-Networks/cato-cli.git
cd cato-cli
python3 -m catocli --help
Guides
- Common Patterns and Best Practices: output formats, time frames, and filtering
- Python Integration on Windows
- Python Integration on Unix, Linux, and macOS
- SIEM Integration: real-time security event streaming
- Terraform Rules Integration: policy export and import for infrastructure as code
Reporting guides
- Account Metrics: network performance by site, user, or interface
- Application Statistics: user and application activity
- Application Statistics Time Series: traffic over time
- Events Time Series: security, connectivity, and threat events
- Socket Port Metrics: socket interface performance
- Socket Port Time Series: socket performance over time
Examples
Account metrics
catocli query accountMetrics '{"timeFrame":"last.PT1H"}'
User activity CSV
catocli query appStats '{
"appStatsFilter": [],
"appStatsSort": [],
"dimension": [ { "fieldName": "user_name" }, { "fieldName": "domain" } ],
"measure": [
{ "aggType": "sum", "fieldName": "upstream" },
{ "aggType": "sum", "fieldName": "downstream" },
{ "aggType": "sum", "fieldName": "traffic" },
{ "aggType": "sum", "fieldName": "flows_created" }
],
"timeFrame": "last.P1D"
}' -f csv --csv-filename appStats_daily_user_activity_report.csv
Security event analysis
catocli query eventsTimeSeries '{
"buckets": 7,
"eventsFilter": [{"fieldName": "event_type", "operator": "is", "values": ["Security"]}],
"eventsMeasure": [{"aggType": "sum", "fieldName": "event_count"}],
"perSecond": false,
"timeFrame": "last.P7D"
}' -f csv --csv-filename eventsTimeSeries_weekly_security_events_report.csv
Output formats
Reporting operations support:
- Enhanced JSON output by default
- Original API JSON with
--raw - CSV output with
-f csv - Custom filenames with
--csv-filename - Timestamped filenames with
--append-timestamp
Check operation help before using format-specific options:
catocli query appStats --help
Time frames
Common time frame patterns:
last.PT1H: last hourlast.P1D: last daylast.P7D: last seven dayslast.P1M: last monthutc.2026-08-{01/00:00:00--01/23:59:59}: custom UTC range
Getting Help
- Add
-hor--helpto any command - Read the Cato API documentation
- Verify installed versions with
catocli --versionandpython3 --version - Download Python from python.org
License
See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for catocli 3.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| catocli-3.2.1.tar.gz | 20.1 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| catocli-3.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 42.2 MB
Release files / catocli-3.2.1.tar.gz
| Download URL | catocli-3.2.1.tar.gz |
|---|---|
| Size | 20.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01b68baa3a4ff234d6be5c07cc50533118885886438a1c424fc0a2336e0e1510
|
|
BLAKE2b-256 checksum How to use checksums |
3fcb408822dc793943e701e37b09b92703d3c818fe043741f933866e1e8f949a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / catocli-3.2.1-py3-none-any.whl
| Download URL | catocli-3.2.1-py3-none-any.whl |
|---|---|
| Size | 22.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc950be73a3bdb2a4edff8b1d5a9aaea1974837fa7aae2644da89fe619a4e0d7
|
|
BLAKE2b-256 checksum How to use checksums |
d9b9e80fac017bbe70d71cb8fdc0b02db6bbff979fc2c88908ac8f46d4a542e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logSecurity for catocli 3.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for catocli-3.2.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
