Support Support Downloads Knowledge Base Juniper Support Portal Community

Knowledge Base

Search our Knowledge Base sites to find answers to your questions.

Ask All Knowledge Base Sites All Knowledge Base Sites JunosE Defect (KA)Knowledge BaseSecurity AdvisoriesTechnical BulletinsTechnotes Sign in to display secure content and recently viewed articles

[CSO] POSTMAN API to check site properties including connectivity information



Article ID: KB37446 KB Last Updated: 21 Sep 2021Version: 1.0

This article describes an alternative way to check connectivity information (link information) related to a tenant site other than checking via the CSO UI.


Perform the following steps:

  1. Get the authentication token for the site that needs to be used in POSTMAN to send the GET request. Refer to KB36299 - [CSO] Getting CSO AUTH token using development tools in the browser.

  2. Get the site UUID by using the following API. Search for the required site to get the UUID.

https://<cso ip> /topology-service/site 

<Output snip for a test site "TESTABC">

            "fq_name": [
            "uuid": "6d29e1d7-a628-4643-b19c-4ccb6dc12412",

The topology service microservice provides all connectivity and other basic information about the site.

  1. Use a "GET request" on the following API to get the connectivity information. Make use of the site UUID obtained from the above output.

https://<cso ip> /topology-service/site/<site UUID>

<Output snip>

display_name": "TESTABC",
        "properties": {
            "property": [
                    "name": "site_basic_properties",
                    "value": {
                        "local_breakout": null,
                        "site_type": "on_premise",
                        "cloud_service": "EDGE",
                        "site_address": {
                            "city": null,
                            "country": "US",
                            "street2": null,
                            "state": null,
                            "street": null,
                            "zip_code": null
                        "device_redundancy": false,
                        "site_deployment_capabilities": [
                        "multi_homing_enabled": false,
                        "site_description": null,
                        "on_premise_gateway": false,
                        "site_role": "SPOKE",
                        "device_template": [
                                "lan_segment": [],
                                "wan_link_info": [
                                        "exclusive_for_local_breakout": false,
                                        "enable_pppoe": false,
                                        "wan_link_type": "Internet",
                                        "address_assignment": null,
                                        "preferred_breakout_link": false,
                                        "wan_link": "WAN_0",
                                        "static_ip_assignment": null,
                                        "traffic_type": null,
                                        "public_ip": null,
                                        "cost": 800,
                                        "subscribed_bandwidth": 1000,
                                        "backup_link": false,
                                        "local_breakout_enabled": true,
                                        "cost_currency": "USD",
                                        "default_link": false,
                                        "provider": "ISP1",
                                        "used_for_oam": false,
                                        "access_type": "Ethernet"
                                "device_name": "TESTABC",
                                "ex_behind_cpe": null
Comment on this article > Affected Products Browse the Knowledge Base for more articles related to these product categories. Select a category to begin.

Getting Up and Running with Junos

Getting Up and Running with Junos Security Alerts and Vulnerabilities Product Alerts and Software Release Notices Problem Report (PR) Search Tool EOL Notices and Bulletins JTAC User Guide Customer Care User Guide Pathfinder SRX High Availability Configurator SRX VPN Configurator Training Courses and Videos End User Licence Agreement Global Search