Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Networks Design API

Design elements including rack types, templates, and logical devices

Juniper Networks Design 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 Design. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 4 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.

6 operations 4 paths 4 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.2.0
Base URL
https://[space-server]/api/space
Authentication
API Key
Terms of Service
Resource Areas
1

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 the /aaa/login endpoint. Include as AuthToken header in all 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 6

Design elements including rack types, templates, and logical devices

GET
/design/rack-types
Juniper Networks List rack types
listRackTypes → 200
POST
/design/rack-types
Juniper Networks Create rack type
createRackType body → 201
GET
/design/templates
Juniper Networks List design templates
listDesignTemplates → 200
POST
/design/templates
Juniper Networks Create design template
createDesignTemplate body → 201
GET
/design/logical-devices
Juniper Networks List logical devices
listLogicalDevices → 200
GET
/design/interface-maps
Juniper Networks List interface maps
listInterfaceMaps → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are DesignTemplate (7 properties), RackType (6 properties), InterfaceMap (5 properties), LogicalDevice (3 properties). Each schema is shown below with its type and property counts.

LogicalDevice
object
3 properties
RackType
object
6 properties
DesignTemplate
object
7 properties
InterfaceMap
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-design-api-openapi.yml Raw ↑

Other APIs Juniper Networks publishes across the network.

Junos PyEZ (Python API)
JSNAPy API
Juniper Networks Allowlists and Blocklists API
Juniper Networks Analytics API
Juniper Networks Audit Logs API
Juniper Networks Authentication API
Juniper Networks BGP Routers API
Juniper Networks Blueprints API
Juniper Networks Clients API
Juniper Networks Configlets API
Juniper Networks Configuration API
Juniper Networks Connectivity Templates API