Juniper Networks

Juniper Networks Operational API

Operational data retrieval

GitHub OpenAPI

Operations 8

GET /rpc/get-software-information Juniper Networks Get software version information #
GET /rpc/get-interface-information Juniper Networks Get interface information #
GET /rpc/get-route-information Juniper Networks Get routing table information #
GET /rpc/get-bgp-neighbor-information Juniper Networks Get BGP neighbor information #
GET /rpc/get-chassis-inventory Juniper Networks Get chassis inventory #
GET /rpc/get-alarm-information Juniper Networks Get alarm information #
GET /rpc/get-system-uptime-information Juniper Networks Get system uptime #
GET /rpc/get-lldp-neighbors-information Juniper Networks Get LLDP neighbor information #

Documentation

📖
Documentation
https://www.juniper.net/documentation/us/en/software/junos-space/
📖
Documentation
https://www.juniper.net/documentation/us/en/software/apstra/
📖
APIReference
https://www.juniper.net/documentation/us/en/software/apstra/apstra-user-guide/topics/concept/apstra-api-overview.html
📖
Documentation
https://www.juniper.net/documentation/us/en/software/junos/rest-api/
📖
Documentation
https://www.mist.com/documentation/mist-api/
📖
APIReference
https://doc.mist-lab.fr/
📖
Documentation
https://www.juniper.net/documentation/us/en/software/contrail/
📖
Documentation
https://www.juniper.net/documentation/us/en/software/atp/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/openapi/juniper-operational-api-openapi.yml

Other Resources

🔗
API Explorer
https://[device-ip]/api-explorer
🔗
Swagger
https://api.mist.com/api/v1/docs
🔗
GitHub
https://github.com/Juniper/contrail-controller

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/juniper-operational-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

juniper-operational-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Juniper Networks Junos REST Operational API
  description: The Junos REST API provides a RESTful interface for configuring, monitoring, and managing individual Junos devices. It translates HTTP requests into Junos RPC calls and supports operations such as retrieving operational data, modifying configuration, committing changes, and executing RPC commands. The API is available on Junos devices with the rest-api service enabled and uses the /rpc endpoint for RPC-style operations and the /api endpoint for structured resource access.
  version: 1.0.0
  contact:
    name: Juniper Support
    url: https://www.juniper.net/documentation/us/en/software/junos/rest-api/
    email: support@juniper.net
  license:
    name: Proprietary
    url: https://www.juniper.net/us/en/legal-notices.html
servers:
- url: https://{device_ip}:3443
  description: Junos Device REST API (HTTPS)
  variables:
    device_ip:
      default: 192.168.1.1
      description: IP address of the Junos device
- url: http://{device_ip}:3000
  description: Junos Device REST API (HTTP)
  variables:
    device_ip:
      default: 192.168.1.1
      description: IP address of the Junos device
security:
- basicAuth: []
tags:
- name: Operational
  description: Operational data retrieval
paths:
  /rpc/get-software-information:
    get:
      operationId: getSoftwareInformation
      summary: Juniper Networks Get software version information
      description: Returns the Junos software version and related information.
      tags:
      - Operational
      responses:
        '200':
          description: Software information
          content:
            application/json:
              schema:
                type: object
                properties:
                  software-information:
                    type: object
                    properties:
                      host-name:
                        type: string
                      product-model:
                        type: string
                      product-name:
                        type: string
                      junos-version:
                        type: string
                      package-information:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            comment:
                              type: string
            application/xml:
              schema:
                type: string
  /rpc/get-interface-information:
    get:
      operationId: getInterfaceInformation
      summary: Juniper Networks Get interface information
      description: Returns interface status and statistics. Equivalent to the Junos CLI command 'show interfaces'.
      tags:
      - Operational
      parameters:
      - name: interface-name
        in: query
        description: Specific interface name (e.g., ge-0/0/0)
        schema:
          type: string
      - name: terse
        in: query
        description: Show terse output
        schema:
          type: boolean
      responses:
        '200':
          description: Interface information
          content:
            application/json:
              schema:
                type: object
                properties:
                  interface-information:
                    type: object
                    properties:
                      physical-interface:
                        type: array
                        items:
                          $ref: '#/components/schemas/PhysicalInterface'
  /rpc/get-route-information:
    get:
      operationId: getRouteInformation
      summary: Juniper Networks Get routing table information
      description: Returns routing table entries. Equivalent to the Junos CLI command 'show route'.
      tags:
      - Operational
      parameters:
      - name: destination
        in: query
        description: Specific route destination prefix
        schema:
          type: string
      - name: table
        in: query
        description: Routing table name
        schema:
          type: string
      responses:
        '200':
          description: Route information
          content:
            application/json:
              schema:
                type: object
                properties:
                  route-information:
                    type: object
                    properties:
                      route-table:
                        type: array
                        items:
                          $ref: '#/components/schemas/RouteTable'
  /rpc/get-bgp-neighbor-information:
    get:
      operationId: getBgpNeighborInformation
      summary: Juniper Networks Get BGP neighbor information
      description: Returns BGP session and neighbor information. Equivalent to the Junos CLI command 'show bgp neighbor'.
      tags:
      - Operational
      responses:
        '200':
          description: BGP neighbor information
          content:
            application/json:
              schema:
                type: object
                properties:
                  bgp-information:
                    type: object
                    properties:
                      bgp-peer:
                        type: array
                        items:
                          $ref: '#/components/schemas/BgpPeer'
  /rpc/get-chassis-inventory:
    get:
      operationId: getChassisInventory
      summary: Juniper Networks Get chassis inventory
      description: Returns the hardware inventory of the device chassis. Equivalent to the Junos CLI command 'show chassis hardware'.
      tags:
      - Operational
      responses:
        '200':
          description: Chassis inventory
          content:
            application/json:
              schema:
                type: object
                properties:
                  chassis-inventory:
                    type: object
                    properties:
                      chassis:
                        type: object
                        properties:
                          name:
                            type: string
                          serial-number:
                            type: string
                          description:
                            type: string
                          chassis-module:
                            type: array
                            items:
                              $ref: '#/components/schemas/ChassisModule'
  /rpc/get-alarm-information:
    get:
      operationId: getAlarmInformation
      summary: Juniper Networks Get alarm information
      description: Returns current system and chassis alarms. Equivalent to the Junos CLI command 'show chassis alarms'.
      tags:
      - Operational
      responses:
        '200':
          description: Alarm information
          content:
            application/json:
              schema:
                type: object
                properties:
                  alarm-information:
                    type: object
                    properties:
                      alarm-summary:
                        type: object
                        properties:
                          active-alarm-count:
                            type: integer
                      alarm-detail:
                        type: array
                        items:
                          $ref: '#/components/schemas/Alarm'
  /rpc/get-system-uptime-information:
    get:
      operationId: getSystemUptimeInformation
      summary: Juniper Networks Get system uptime
      description: Returns system uptime and boot time information.
      tags:
      - Operational
      responses:
        '200':
          description: System uptime information
          content:
            application/json:
              schema:
                type: object
                properties:
                  system-uptime-information:
                    type: object
                    properties:
                      current-time:
                        type: object
                        properties:
                          date-time:
                            type: string
                      system-booted-time:
                        type: object
                        properties:
                          date-time:
                            type: string
                          time-length:
                            type: string
                      last-configured-time:
                        type: object
                        properties:
                          date-time:
                            type: string
                          user:
                            type: string
  /rpc/get-lldp-neighbors-information:
    get:
      operationId: getLldpNeighborsInformation
      summary: Juniper Networks Get LLDP neighbor information
      description: Returns LLDP neighbor discovery data.
      tags:
      - Operational
      responses:
        '200':
          description: LLDP neighbors
          content:
            application/json:
              schema:
                type: object
                properties:
                  lldp-neighbors-information:
                    type: object
                    properties:
                      lldp-neighbor-information:
                        type: array
                        items:
                          $ref: '#/components/schemas/LldpNeighbor'
components:
  schemas:
    BgpPeer:
      type: object
      properties:
        peer-address:
          type: string
        peer-as:
          type: integer
        local-address:
          type: string
        local-as:
          type: integer
        peer-state:
          type: string
          enum:
          - Established
          - Active
          - Connect
          - OpenSent
          - OpenConfirm
          - Idle
        peer-type:
          type: string
          enum:
          - Internal
          - External
        route-received:
          type: integer
        route-accepted:
          type: integer
        route-advertised:
          type: integer
        elapsed-time:
          type: string
    LldpNeighbor:
      type: object
      properties:
        lldp-local-interface:
          type: string
        lldp-local-parent-interface-name:
          type: string
        lldp-remote-chassis-id:
          type: string
        lldp-remote-port-id:
          type: string
        lldp-remote-system-name:
          type: string
    RouteTable:
      type: object
      properties:
        table-name:
          type: string
        destination-count:
          type: integer
        total-route-count:
          type: integer
        active-route-count:
          type: integer
        rt:
          type: array
          items:
            type: object
            properties:
              rt-destination:
                type: string
              rt-entry:
                type: object
                properties:
                  active-tag:
                    type: string
                  protocol-name:
                    type: string
                  preference:
                    type: integer
                  nh:
                    type: array
                    items:
                      type: object
                      properties:
                        to:
                          type: string
                        via:
                          type: string
                        nh-type:
                          type: string
    Alarm:
      type: object
      properties:
        alarm-time:
          type: string
          format: date-time
        alarm-class:
          type: string
          enum:
          - Major
          - Minor
        alarm-description:
          type: string
        alarm-type:
          type: string
    PhysicalInterface:
      type: object
      properties:
        name:
          type: string
          description: Interface name (e.g., ge-0/0/0)
        admin-status:
          type: string
          enum:
          - up
          - down
        oper-status:
          type: string
          enum:
          - up
          - down
        description:
          type: string
        mtu:
          type: integer
        speed:
          type: string
        if-type:
          type: string
        link-level-type:
          type: string
        traffic-statistics:
          type: object
          properties:
            input-packets:
              type: integer
            output-packets:
              type: integer
            input-bytes:
              type: integer
            output-bytes:
              type: integer
        logical-interface:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              address-family:
                type: array
                items:
                  type: object
                  properties:
                    address-family-name:
                      type: string
                    interface-address:
                      type: array
                      items:
                        type: object
                        properties:
                          ifa-local:
                            type: string
                            description: IP address
    ChassisModule:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        part-number:
          type: string
        serial-number:
          type: string
        description:
          type: string
        model-number:
          type: string
        chassis-sub-module:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              serial-number:
                type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with Junos device credentials
externalDocs:
  description: Junos REST API Guide
  url: https://www.juniper.net/documentation/us/en/software/junos/rest-api/