Skip to content

Releases: ancoleman/insights-sdk-cli

v0.3.1 — EB users, other users, generic sessions

Choose a tag to compare

@ancoleman ancoleman released this 07 Apr 19:59

Added

  • get_eb_users() — Enterprise Browser user list
  • get_other_users() — Other/host user list
  • get_user_sessions(user_type) — Generic session list for any user type (agent, agentless, branch, other)

Coverage Summary

SDK now has 52 public methods covering all working Insights 3.0 API endpoints:

Category Status Methods
Agent Users Strong 12 methods
Branch Users Strong via generic methods
Agentless Users Strong list + sessions + generics
Enterprise Browser Strong list + count + histogram + active
Other Users Strong list + sessions + generics
Applications Strong 9 methods
Accelerated Apps Strong 7 methods
Sites Strong 5 methods
PAB Security Strong 6 methods
Monitoring Good 4 methods (user list/count are known API limitations)
Export Good 2 methods

Mobile users = agent type (no separate API). Monitored user list/count = known API limitation (DATA10003).

Install

pip install pan-insights-sdk==0.3.1

Full Changelog: v0.3.0...v0.3.1

v0.3.0 — Full SDK/CLI feature parity

Choose a tag to compare

@ancoleman ancoleman released this 07 Apr 19:49

Added — 21 new SDK methods

SDK now has 49 public methods (up from 28), matching every CLI command.

User Methods

  • get_active_user_count() / get_active_users() — active user count/list
  • get_entity_count() — connected entity count
  • get_client_version_distribution() — agent version distribution
  • get_unique_device_connections() — unique device connections
  • get_current_user_count() — current connected count
  • get_device_count_histogram() — device count over time

Application Methods

  • get_app_bandwidth(app_name) — per-app bandwidth histogram
  • get_app_data_transfer_by_destination() — transfer by destination

Accelerated Application Methods

  • get_accelerated_app_count() / get_accelerated_user_count()
  • get_accelerated_data_transfer(per_app=True/False)
  • get_accelerated_response_time(per_app=True/False)
  • get_accelerated_histogram(metric) — throughput/packet-loss/rtt/boost

Monitoring Methods

  • get_monitored_device_count() / get_monitored_device_count_histogram()

Security (PAB) Methods

  • get_pab_access_events_breakdown() / get_pab_data_events_blocked() / get_pab_data_events_breakdown()

Install

pip install pan-insights-sdk==0.3.0

Full Changelog: v0.2.3...v0.3.0

v0.2.3 — Fix PAB blocked events endpoint path

Choose a tag to compare

@ancoleman ancoleman released this 07 Apr 19:45

Fixed

  • get_pab_access_events_blocked() — was hitting query/pab/access_events_blocked instead of query/applications/pab/access_events_blocked, causing 400 errors
  • CLI security access --blocked — same incorrect endpoint path as the SDK method

Install

pip install pan-insights-sdk==0.2.3

Full Changelog: v0.2.2...v0.2.3

v0.2.2 — Fix SDK endpoint paths and histogram config

Choose a tag to compare

@ancoleman ancoleman released this 07 Apr 19:32

Fixed

  • get_agent_sessions() — was hitting query/users/other/session_list instead of query/users/agent/session_list, returning wrong user type's sessions
  • get_risky_user_count() — was hitting query/agent/risky_user_count (missing users/ prefix) for agent type, causing 400 errors
  • get_user_count_histogram() — was missing required histogram config in request body and using wrong agent endpoint, causing 400 errors
  • get_site_bandwidth() — was missing required histogram config in request body, causing 400 errors for all SDK callers (CLI worked because it added histogram config directly)

Changed

  • get_user_count_histogram() and get_site_bandwidth() now accept an optional interval parameter (default: 30 minutes) for histogram granularity

Install

pip install pan-insights-sdk==0.2.2

Full Changelog: v0.2.1...v0.2.2

v0.2.1

Choose a tag to compare

@ancoleman ancoleman released this 18 Feb 16:06

First PyPI Release

  • Renamed package to pan-insights-sdk on PyPI
  • Install with: pip install pan-insights-sdk
  • Fixed source URLs to point to correct GitHub repo

v0.2.0

Choose a tag to compare

@ancoleman ancoleman released this 27 Nov 03:43
82cdd65

What's Changed

Added

  • Docker Support

    • Multi-stage Dockerfile with Python 3.12-slim base (~150MB image)
    • Dockerfile.dev for running tests in containers
    • docker-compose.yml for easy orchestration
    • Security hardening: non-root user, read-only filesystem, dropped capabilities
  • Makefile

    • Development: make install, make dev, make test, make lint, make format
    • Docker: make build, make run ARGS='...', make shell
    • Release: make dist, make publish, make release VERSION=x.y.z
  • PyPI Publishing

    • GitHub Action for automated publishing on release
    • GitHub Action for CI tests on push/PR
    • Trusted publishing support (no API tokens required)
  • Documentation

    • New docs/installation.md with pip, Docker, source, and CI/CD setup
    • Updated README with all installation methods
  • Testing

    • 26 Docker configuration tests

Installation

pip install insights-sdk

Or with Docker:

docker build -t insights .
docker run --rm insights --help

Full Changelog: v0.1.0...v0.2.0