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, management, and monitoring operations.

Juniper Networks Devices 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 Devices. 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 7 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.

7 operations 4 paths 5 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.2
Base URL
https:///api
Authentication
API Key
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 POST /api/aaa/login. Include in the AuthToken header for all authenticated API requests.

Paths & Operations 7

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

Devices 7

Device discovery, management, and monitoring operations.

GET
/device-management/devices
Juniper Networks List managed devices
listDevices 2 params → 200401
POST
/device-management/devices
Juniper Networks Discover and add device
discoverDevice body → 202400
GET
/device-management/devices/{device_id}
Juniper Networks Get device details
getDevice 1 param → 200404
DELETE
/device-management/devices/{device_id}
Juniper Networks Remove device from management
deleteDevice 1 param → 204404
GET
/sites/{site_id}/devices
Juniper Networks List site devices
listSiteDevices 2 params → 200401
GET
/sites/{site_id}/devices/{device_id}
Juniper Networks Get device
getSiteDevice 2 params → 200401404
PUT
/sites/{site_id}/devices/{device_id}
Juniper Networks Update device
updateSiteDevice 2 params body → 200400401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Device_2 (13 properties), Device (10 properties), Job (9 properties), Error_2 (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property
Device_2
object
13 properties
Job
object
9 properties
Device
object
10 properties
Error_2
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-networks-devices-api-openapi.yml Raw ↑

Other APIs Juniper Networks publishes across the network.

Junos PyEZ
Junos XML API
Juniper JSNAPy
Juniper Networks Alarms API
Juniper Networks Anomalies API
Juniper Networks Authentication API
Juniper Networks BGP Routers API
Juniper Networks Blueprints API
Juniper Networks Clients API
Juniper Networks Configuration API
Juniper Networks Design API
Juniper Networks Floating IPs API