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 Devices API

Device discovery and management

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

This API exposes 9 operations across 5 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.

9 operations 5 paths 4 schemas 2 DELETE5 GET1 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 Devices 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 5 paths, the API surfaces 9 operations — 2 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Devices 9

Device discovery and management

GET
/device-management/devices
Juniper Networks List managed devices
listDevices 3 params → 200
POST
/device-management/devices
Juniper Networks Discover a device
discoverDevice body → 202
GET
/device-management/devices/{device_id}
Juniper Networks Get device details
getDevice 1 param → 200404
DELETE
/device-management/devices/{device_id}
Juniper Networks Delete managed device
deleteDevice 1 param → 204
GET
/sites/{site_id}/devices
Juniper Networks List site devices
listSiteDevices 4 params → 200
GET
/sites/{site_id}/devices/{device_id}
Juniper Networks Get device details
getSiteDevice 2 params → 200
PUT
/sites/{site_id}/devices/{device_id}
Juniper Networks Update device
updateSiteDevice 2 params body → 200
DELETE
/sites/{site_id}/devices/{device_id}
Juniper Networks Delete device
deleteSiteDevice 2 params → 200
GET
/sites/{site_id}/devices/stats
Juniper Networks List site device statistics
listSiteDeviceStats 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Device_2 (16 properties), DeviceStats (11 properties), Device (11 properties), Job (7 properties). Each schema is shown below with its type and property counts.

Device
object
11 properties
DeviceStats
object
11 properties
Device_2
object
16 properties
Job
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-devices-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