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 Virtual Networks API

Virtual network and routing zone management

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

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

9 operations 4 paths 5 schemas 1 DELETE4 GET3 POST1 PUT

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 Virtual Networks 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 9

Across 4 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Virtual Networks 9

Virtual network and routing zone management

GET
/blueprints/{blueprint_id}/security-zones
Juniper Networks List security zones (routing zones / VRFs)
listSecurityZones 1 param → 200
POST
/blueprints/{blueprint_id}/security-zones
Juniper Networks Create security zone
createSecurityZone 1 param body → 201
GET
/blueprints/{blueprint_id}/virtual-networks
Juniper Networks List virtual networks
listVirtualNetworks 1 param → 200
POST
/blueprints/{blueprint_id}/virtual-networks
Juniper Networks Create virtual network
createVirtualNetwork 1 param body → 201
GET
/virtual-networks
Juniper Networks List virtual networks
listVirtualNetworks 2 params → 200
POST
/virtual-networks
Juniper Networks Create virtual network
createVirtualNetwork body → 200
GET
/virtual-network/{vn_id}
Juniper Networks Get virtual network
getVirtualNetwork 1 param → 200
PUT
/virtual-network/{vn_id}
Juniper Networks Update virtual network
updateVirtualNetwork 1 param body → 200
DELETE
/virtual-network/{vn_id}
Juniper Networks Delete virtual network
deleteVirtualNetwork 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are VirtualNetwork (10 properties), VirtualNetwork_2 (8 properties), SecurityZone (7 properties), IdPerms (6 properties). Each schema is shown below with its type and property counts.

VirtualNetwork_2
object
8 properties
VirtualNetwork
object
10 properties
SecurityZone
object
7 properties
ResourceRef
object
3 properties
IdPerms
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-virtual-networks-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