# wingpy

> Wingpy is a Python REST API client library for network engineers, with task-oriented guides, generated API reference, FAQ, and release notes.

Use this file to navigate the Wingpy documentation efficiently.

Start with the **User Guide** for installation, authentication patterns, and platform-specific examples.  
Use the **API Reference** for exact classes, methods, parameters, return values, and exceptions.  
Use the **FAQ** to confirm expected behavior around sessions, token refresh, context managers, exceptions, and environment variables.  
Use the **Changelog** when version-specific behavior matters.

If your retrieval system can access both rendered docs and source Markdown, prefer Markdown for parsing and use the canonical documentation URLs here for navigation.

## Core Documentation

- [Home](https://wingpy.automation.wingmen.dk/): Product overview and top-level navigation.
- [User Guide](https://wingpy.automation.wingmen.dk/user-guide/): Installation, getting started, authentication, concurrency, logging, and platform entry points.
- [API Reference](https://wingpy.automation.wingmen.dk/api/): Generated technical reference for classes, methods, modules, and exceptions.
- [FAQ](https://wingpy.automation.wingmen.dk/faq/): Common questions about sessions, errors, context managers, and environment variables.
- [Changelog](https://wingpy.automation.wingmen.dk/changelog/): Release history and version-specific changes.
- [LLMs and AI agents](https://wingpy.automation.wingmen.dk/llm/): How to install and use the `wingpy-coding-skill` for AI code assistants.

## Common Entry Points

- [User Guide](https://wingpy.automation.wingmen.dk/user-guide/): Best first stop for “how do I use Wingpy for this platform/task?”
- [Base REST API Class](https://wingpy.automation.wingmen.dk/api/base/): Core abstractions for requests, headers, retries, throttling, path parameters, logging, and session lifetime.
- [FAQ](https://wingpy.automation.wingmen.dk/faq/): Best first stop for “is this behavior expected?”
- [Changelog](https://wingpy.automation.wingmen.dk/changelog/): Best first stop for “did this change recently?”

## Platform Guides

- [Cisco APIC User Guide](https://wingpy.automation.wingmen.dk/user-guide/apic/): Authentication and examples for Cisco APIC / ACI, including JSON and XML usage.
- [Cisco Catalyst Center User Guide](https://wingpy.automation.wingmen.dk/user-guide/catalyst-center/): Authentication, examples, and async task patterns for Catalyst Center.
- [Cisco SD-WAN vManage User Guide](https://wingpy.automation.wingmen.dk/user-guide/vmanage/): Authentication and examples for Cisco SD-WAN vManage workflows.
- [Cisco FMC User Guide](https://wingpy.automation.wingmen.dk/user-guide/fmc/): Authentication, CRUD examples, and domain UUID handling.
- [Cisco Hyperfabric User Guide](https://wingpy.automation.wingmen.dk/user-guide/hyperfabric/): Token-based workflows, CRUD examples, and bulk operations.
- [Cisco ISE User Guide](https://wingpy.automation.wingmen.dk/user-guide/ise/): OpenAPI and ERS usage, filtering, paging, and bulk operations.
- [Cisco Meraki Dashboard User Guide](https://wingpy.automation.wingmen.dk/user-guide/meraki-dashboard/): Token-based workflows, path parameterization, and concurrency caveats.
- [Cisco Modeling Labs User Guide](https://wingpy.automation.wingmen.dk/user-guide/cml/): Authentication, examples, and task-oriented CML workflows.
- [Nautobot User Guide](https://wingpy.automation.wingmen.dk/user-guide/nautobot/): Token-based Nautobot workflows and IPAM examples.
- [NetBox User Guide](https://wingpy.automation.wingmen.dk/user-guide/netbox/): Token-based NetBox workflows and IPAM examples.
- [Cisco Nexus Dashboard User Guide](https://wingpy.automation.wingmen.dk/user-guide/nexus-dashboard/): Authentication and examples for Nexus Dashboard APIs.
- [Splunk Enterprise User Guide](https://wingpy.automation.wingmen.dk/user-guide/splunk/): Authentication, XML handling, XPath usage, and paginated result retrieval.

## Suggested Retrieval Strategy

- For platform-specific coding tasks, go directly to the matching **Platform Guide**.
- For exact method signatures or constructor parameters, go to the **API Reference**.
- For uncertainty around sessions, token refresh, exceptions, or context managers, go to the **FAQ**.
- For differences between releases, go to the **Changelog**.