Juniper Networks Design API
Design resources including logical devices, interface maps, rack types, templates, and config templates.
Juniper Networks Design API is one of 35 APIs that Juniper Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Design. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, an AsyncAPI specification, and 4 JSON Schemas.
This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 4.2.
Requests are made against a single base URL, https://{apstra_server}/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Juniper Networks Design API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as AuthToken (authToken).
By default, every request must be authenticated.
authToken— Authentication token obtained from POST /api/aaa/login. Include in the AuthToken header for all authenticated API requests.
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Design resources including logical devices, interface maps, rack types, templates, and config templates.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RackType (6 properties), Template (5 properties), InterfaceMap (5 properties), LogicalDevice (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Juniper Networks 12
Other APIs Juniper Networks publishes across the network.