Files
Anthropic-Cybersecurity-Skills/skills/performing-ics-asset-discovery-with-claroty/references/api-reference.md
T
mukul975 c21af3347e Complete folder anatomy for all 649 cybersecurity skills + update LICENSE to Mahipal
- Add scripts/agent.py and references/api-reference.md to all remaining skills
- Update all 648 LICENSE files: copyright now reads 'Mahipal'
- Add implementing-security-monitoring-with-datadog (new skill with full anatomy)
- All 649 skills now have: SKILL.md, LICENSE, scripts/agent.py, references/api-reference.md
2026-03-11 00:22:12 +01:00

46 lines
1.5 KiB
Markdown

# API Reference — Performing ICS Asset Discovery with Claroty
## Libraries Used
- **requests**: HTTP client for Claroty xDome / CTD REST API
## CLI Interface
```
python agent.py --url <claroty_base_url> --token <api_token> assets [--type PLC] [--limit 100]
python agent.py --url <claroty_base_url> --token <api_token> vulns [--severity critical] [--limit 100]
python agent.py --url <claroty_base_url> --token <api_token> alerts
python agent.py --url <claroty_base_url> --token <api_token> topology
```
## ClarotyClient Class
### `get_assets(asset_type, limit)` — Retrieve OT/IoT assets
**Endpoint:** `GET /api/v1/assets`
Filters by type: PLC, HMI, RTU, EWS, Switch, Sensor.
### `get_asset_detail(asset_id)` — Detailed asset information
**Endpoint:** `GET /api/v1/assets/{id}`
### `get_vulnerabilities(severity, limit)` — OT vulnerability list
**Endpoint:** `GET /api/v1/vulnerabilities`
### `get_alerts(status, limit)` — Security alerts
**Endpoint:** `GET /api/v1/alerts`
### `get_network_segments()` — Network segmentation map
**Endpoint:** `GET /api/v1/network/segments`
## Core Functions
### `discover_assets(...)` — Categorize assets by type, vendor, criticality
### `assess_vulnerabilities(...)` — Prioritize OT vulnerabilities by severity
### `get_alerts_summary(...)` — Summarize active security alerts
### `network_topology(...)` — Map Purdue model network zones
## Authentication
Bearer token via `Authorization: Bearer <token>` header.
## Dependencies
```
pip install requests
```