REST API Data Structures Overview
This section describes the objects used by the Cisco Multi-Site REST API and their hierarchy. The objects are represented using JavaScript Object Notation (JSON) format with the top level containing Schemas. The data structure is consistent across Multi-Site with Schemas containing templates and tempaltes containing lower level objects such as application network profiles (anps), bridge domains (bds), virtual routing and forwarding (vrfs) instances and so on. These entities also contain other smaller structures.
A few high-level entities or concepts are described in the following sections. In the examples presented, when a field name
is pluralized (such as vrfs
or bds
), the field contains an array of that type of objects associated with the parent structure. For example, the vrfs
array contains all the VRF instances associated with the template.
For a complete object and method reference, see the OpenAPI reference as described in REST API Reference (OpenAPI/Swagger).