Juniper Networks Operational API
Operational data retrieval
Juniper Networks Operational API is one of 48 APIs that Juniper Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Operational. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 8 operations across 8 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 4.2.0.
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 Operational 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 the /aaa/login endpoint. Include as AuthToken header in all requests.
Paths & Operations 8
Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.
Operational data retrieval
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are BgpPeer (10 properties), PhysicalInterface (10 properties), ChassisModule (7 properties), RouteTable (5 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.