Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document provides guidance for GitHub Copilot when working with the Insight

## Project Overview

InsightVM-Python is a modern Python client library for Rapid7 InsightVM and Palo Alto Cortex XDR APIs. The project follows industry-standard patterns with comprehensive type hints and clean, intuitive interfaces.
InsightVM-Python is a modern Python client library for Rapid7 InsightVM API. The project follows industry-standard patterns with comprehensive type hints and clean, intuitive interfaces.

**Version:** 2.0.0
**Python Support:** 3.8+
Expand Down Expand Up @@ -42,7 +42,6 @@ insightvm-python/
│ │ ├── scan_templates.py # Template management
│ │ └── sonar_queries.py # Sonar integration
│ └── tools/ # Standalone utility scripts
├── src/paloalto/ # Palo Alto Cortex XDR package
├── docs/ # Documentation
├── tests/ # Test suite
│ ├── conftest.py # Shared pytest fixtures
Expand Down
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Removed

Check notice on line 10 in CHANGELOG.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

CHANGELOG.md#L10

Expected: 1; Actual: 0; Below
- 🔥 **BREAKING**: Removed Palo Alto Cortex XDR integration from main codebase

Check notice on line 11 in CHANGELOG.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

CHANGELOG.md#L11

Lists should be surrounded by blank lines
- Moved to dedicated development branch for independent development
- Main repository now focuses exclusively on Rapid7 InsightVM functionality
- Palo Alto XDR code available in git history (commit 559a63e and earlier)

## [2.0.0] - 2025-10-07

### 🎉 Major Release - Complete Architecture Refactoring
Expand Down Expand Up @@ -166,7 +174,6 @@
- Asset retrieval capabilities
- Asset group creation
- Database storage support (PostgreSQL)
- Palo Alto Cortex XDR integration
- Agent installation tools
- Manual Base64 authentication

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![License](https://img.shields.io/badge/license-MIT-orange.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8676b480eff04517b65bc3bfcfeaea9a)](https://app.codacy.com/gh/talltechy/insightvm-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

A modern Python client library for Rapid7 InsightVM and Palo Alto Cortex XDR APIs. Built with industry-standard patterns, comprehensive type hints, and a clean, intuitive interface.
A modern Python client library for Rapid7 InsightVM API. Built with industry-standard patterns, comprehensive type hints, and a clean, intuitive interface.

## ✨ Features

Expand Down Expand Up @@ -471,7 +471,6 @@ Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for gu

- [Official Rapid7 InsightVM API](https://help.rapid7.com/insightvm/en-us/api/index.html)
- [Official Rapid7 InsightVM API Examples](https://github.com/rapid7/insightvm-api-examples)
- [Palo Alto Cortex XDR API](https://docs-cortex.paloaltonetworks.com/r/Cortex-XDR/Cortex-XDR-API-Reference/APIs-Overview)

## 📝 License

Expand Down
76 changes: 76 additions & 0 deletions docs/PALOALTO_XDR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Palo Alto Cortex XDR Integration

Check notice on line 1 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L1

Expected: [None]; Actual: # Palo Alto Cortex XDR Integration

## Status: Moved to Separate Development Branch

As of version 2.1, the Palo Alto Cortex XDR integration has been moved to a dedicated development branch to keep the main repository focused on Rapid7 InsightVM functionality.

Check notice on line 5 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L5

Expected: 80; Actual: 175

## Accessing the Palo Alto XDR Code

### Option 1: Check Out from Git History

The Palo Alto XDR code is available in the git history. You can access it by checking out a commit before the removal:

Check notice on line 11 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L11

Expected: 80; Actual: 118

```bash
# View the last commit that included Palo Alto code
git log --all --full-history -- src/paloalto/

# Check out the specific commit (replace with actual commit hash)
git checkout 559a63e -- src/paloalto/
```

### Option 2: Browse on GitHub

You can view the Palo Alto XDR code in the GitHub repository history:

1. Go to the repository: https://github.com/talltechy/insightvm-python

Check notice on line 25 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L25

Bare URL used
2. Navigate to `src/paloalto/` in any commit before this change
3. View commit `559a63e` or earlier

### Files Included

The Palo Alto Cortex XDR integration consisted of:

- `src/paloalto/__init__.py` - Package initialization
- `src/paloalto/api_pa_xdr.py` - Main API client with functions for:
- Incident management
- Endpoint management
- Alert management
- Endpoint isolation/quarantine operations
- `src/paloalto/api_pa_xdr_auth.py` - Authentication helper functions

### Environment Variables Required

If you restore the Palo Alto XDR code, you'll need these environment variables:

```bash
XDR_API_KEY=your_xdr_api_key
XDR_API_KEY_ID=your_xdr_api_key_id
XDR_BASE_URL=https://api-your-region.xdr.us.paloaltonetworks.com
```

## Why Was This Moved?

The Palo Alto Cortex XDR integration was moved to a separate development branch for the following reasons:

Check notice on line 53 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L53

Expected: 80; Actual: 106

1. **Focus**: Keep the main repository focused on Rapid7 InsightVM
2. **Maintainability**: Separate development cycles for different products
3. **Clarity**: Clear separation of concerns between different API integrations
4. **Independence**: Allow each integration to evolve independently

## Future Plans

The Palo Alto Cortex XDR integration may be:
- Developed as a separate package (`paloalto-cortex-xdr-python`)

Check notice on line 63 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L63

Lists should be surrounded by blank lines
- Maintained on a long-lived feature branch
- Released as a separate project

## Questions?

For questions about the Palo Alto XDR integration, please:
1. Check the git history for implementation details

Check notice on line 70 in docs/PALOALTO_XDR.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/PALOALTO_XDR.md#L70

Lists should be surrounded by blank lines
2. Open an issue in the repository for discussion
3. Contact the maintainers if you're interested in continuing XDR development

## References

- [Palo Alto Cortex XDR API Documentation](https://docs-cortex.paloaltonetworks.com/r/Cortex-XDR/Cortex-XDR-API-Reference/APIs-Overview)
Empty file removed src/paloalto/__init__.py
Empty file.
Loading
Loading