Developers

Developer documentation and tools are available for AOS users in the Developers option in the AOS UI Platform menu.

API Documentation

The Documentation section includes links to the AOS in-product API documentation.

Platform REST API Documentation includes API documentation for APIs used outside of an AOS Blueprint (e.g. AOS Global Catalog Logical Devices).

Reference Designs Two stage L3 Clos includes API documentation for APIs used in the standard AOS L3 Clos Blueprint (e.g. AOS Blueprint Virtual-Networks).

Reference Designs enterprise is for future functionality and is not currently supported by Apstra.

API Examples

Examples for using the Apstra AOS API can be found in one of these sections.

• Resource Pools API Reference
• Configlet API Reference
• Property Set API Reference
• External Routers API Reference
• Interface Descriptions
• IBA Probes API Reference
• RCI Fault Model API Methods
• AOS Cluster APIs
• Using API From Python

Tools

Documentation for available Apstra AOS Developer Tools can be found in one of these sections.

• REST API Explorer