Lavelle Insights API Service

Lavelle Networks APIs for CloudStation Insights
Contact Info: level3-support@lavellenetworks.com
Version: 0.0.1
BasePath:/analytics
http://apache.org/licenses/LICENSE-2.0.html
All rights reserved

Access

Methods

[ Jump to Models ]

GetClusterHealth cluster ( clusterGetClusterHealth)
Get cluster health

Return type

GetClusterHealthOKResponseBody

Example data

Content-Type: application/json
			
                {
                                  "message" : "message",
                                  "clusters" : [ {
                                    "insights_name" : "insights_name",
                                    "is_master" : true,
                                    "instances" : {
                                      "key" : {
                                        "memory" : {
                                          "key" : "memory"
                                        },
                                        "disks" : {
                                          "key" : "disks"
                                        },
                                        "cnid" : "cnid",
                                        "cpu" : {
                                          "key" : "cpu"
                                        }
                                      }
                                    },
                                    "switch_timestamp" : "switch_timestamp",
                                    "core_name" : "core_name",
                                    "delegation" : "delegation",
                                    "total_elapsed_time" : 0
                                  }, {
                                    "insights_name" : "insights_name",
                                    "is_master" : true,
                                    "instances" : {
                                      "key" : {
                                        "memory" : {
                                          "key" : "memory"
                                        },
                                        "disks" : {
                                          "key" : "disks"
                                        },
                                        "cnid" : "cnid",
                                        "cpu" : {
                                          "key" : "cpu"
                                        }
                                      }
                                    },
                                    "switch_timestamp" : "switch_timestamp",
                                    "core_name" : "core_name",
                                    "delegation" : "delegation",
                                    "total_elapsed_time" : 0
                                  } ]
                                }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetClusterHealthOKResponseBody

400

Bad Request response. GetClusterHealthOKResponseBody

422

Unprocessable Entity response. GetClusterHealthOKResponseBody

500

Internal Server Error response. GetClusterHealthOKResponseBody

GetFlows flows ( flowsGetFlows)
Get all flows

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetFlowsRequestBody (required)
Body Parameter —

Return type

GetFlowsOKResponseBody

Example data

Content-Type: application/json
			
{
  "flows" : [ { }, { } ],
  "session_id" : "session_id",
  "message" : "message",
  "to_time" : "to_time",
  "from_time" : "from_time",
  "load_more" : "load_more"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetFlowsOKResponseBody

422

Unprocessable Entity response. GetFlowsOKResponseBody

500

Internal Server Error response. GetFlowsOKResponseBody

GetSortedApps flows ( flowsGetSortedApps)
Get filtered & sorted top applications based on the flow records

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetSortedFlowsRequestBody (required)
Body Parameter —

Return type

GetSortedAppsOKResponseBody

Example data

Content-Type: application/json
			
{
  "message" : "message",
  "sorted_apps" : {
    "key" : {
      "download" : 1,
      "upload" : 1,
      "upload_percent" : 1,
      "name" : "name",
      "download_percent" : 1,
      "cumulative" : 1,
      "cumulative_percent" : 1
    }
  },
  "version" : "version"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetSortedAppsOKResponseBody

422

Unprocessable Entity response. GetSortedAppsOKResponseBody

500

Internal Server Error response. GetSortedAppsOKResponseBody

GetSortedFlows flows ( flowsGetSortedFlows)
Get filtered & sorted flows

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetSortedFlowsRequestBody (required)
Body Parameter —

Return type

GetSortedFlowsOKResponseBody

Example data

Content-Type: application/json
			
                {
                                  "message" : "message",
                                  "sorted_flows" : {
                                    "key" : {
                                      "download" : 1,
                                      "upload" : 1,
                                      "upload_percent" : 1,
                                      "name" : "name",
                                      "download_percent" : 1,
                                      "cumulative" : 1,
                                      "cumulative_percent" : 1
                                    }
                                  },
                                  "version" : "version"
                                }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetSortedFlowsOKResponseBody

422

Unprocessable Entity response. GetSortedFlowsOKResponseBody

500

Internal Server Error response. GetSortedFlowsOKResponseBody

GetNetworkTopology info ( infoGetNetworkTopology)
Get current network topology

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetNetworkTopologyRequestBody (required)
Body Parameter —

Return type

GetNetworkTopologyOKResponseBody

Example data

Content-Type: application/json
			
                {
                                  "data" : [ {
                                    "spoc" : "spoc",
                                    "profile" : {
                                      "business_hours" : "business_hours",
                                      "business_weekdays" : "business_weekdays",
                                      "name" : "name",
                                      "id" : "id"
                                    },
                                    "name" : "name",
                                    "cloudports" : [ {
                                      "interfaces" : [ {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      }, {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      } ],
                                      "total_bb_interfaces" : 0,
                                      "total_dongle_interfaces" : 6,
                                      "version" : "version",
                                      "total_mpls_interfaces" : 5,
                                      "total_pppoe_interfaces" : 2,
                                      "name" : "name",
                                      "model" : "model",
                                      "id" : "id",
                                      "last_seen_at" : "last_seen_at",
                                      "total_wan_interfaces" : 7,
                                      "serial_no" : "serial_no",
                                      "total_interfaces" : 1,
                                      "total_lan_interfaces" : 5,
                                      "hardware" : {
                                        "total_memory" : "total_memory",
                                        "total_disk" : "total_disk",
                                        "num_emb_sim_slots" : "num_emb_sim_slots",
                                        "num_usb_ports" : "num_usb_ports",
                                        "num_network_ports" : "num_network_ports",
                                        "ports" : [ {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        }, {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        } ],
                                        "num_cpu" : "num_cpu"
                                      }
                                    }, {
                                      "interfaces" : [ {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      }, {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      } ],
                                      "total_bb_interfaces" : 0,
                                      "total_dongle_interfaces" : 6,
                                      "version" : "version",
                                      "total_mpls_interfaces" : 5,
                                      "total_pppoe_interfaces" : 2,
                                      "name" : "name",
                                      "model" : "model",
                                      "id" : "id",
                                      "last_seen_at" : "last_seen_at",
                                      "total_wan_interfaces" : 7,
                                      "serial_no" : "serial_no",
                                      "total_interfaces" : 1,
                                      "total_lan_interfaces" : 5,
                                      "hardware" : {
                                        "total_memory" : "total_memory",
                                        "total_disk" : "total_disk",
                                        "num_emb_sim_slots" : "num_emb_sim_slots",
                                        "num_usb_ports" : "num_usb_ports",
                                        "num_network_ports" : "num_network_ports",
                                        "ports" : [ {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        }, {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        } ],
                                        "num_cpu" : "num_cpu"
                                      }
                                    } ],
                                    "location" : "location",
                                    "id" : "id",
                                    "is_hub" : "is_hub"
                                  }, {
                                    "spoc" : "spoc",
                                    "profile" : {
                                      "business_hours" : "business_hours",
                                      "business_weekdays" : "business_weekdays",
                                      "name" : "name",
                                      "id" : "id"
                                    },
                                    "name" : "name",
                                    "cloudports" : [ {
                                      "interfaces" : [ {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      }, {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      } ],
                                      "total_bb_interfaces" : 0,
                                      "total_dongle_interfaces" : 6,
                                      "version" : "version",
                                      "total_mpls_interfaces" : 5,
                                      "total_pppoe_interfaces" : 2,
                                      "name" : "name",
                                      "model" : "model",
                                      "id" : "id",
                                      "last_seen_at" : "last_seen_at",
                                      "total_wan_interfaces" : 7,
                                      "serial_no" : "serial_no",
                                      "total_interfaces" : 1,
                                      "total_lan_interfaces" : 5,
                                      "hardware" : {
                                        "total_memory" : "total_memory",
                                        "total_disk" : "total_disk",
                                        "num_emb_sim_slots" : "num_emb_sim_slots",
                                        "num_usb_ports" : "num_usb_ports",
                                        "num_network_ports" : "num_network_ports",
                                        "ports" : [ {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        }, {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        } ],
                                        "num_cpu" : "num_cpu"
                                      }
                                    }, {
                                      "interfaces" : [ {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      }, {
                                        "secondary_ip" : [ "secondary_ip", "secondary_ip" ],
                                        "role" : "role",
                                        "port_type" : "port_type",
                                        "primary_ip" : "primary_ip",
                                        "isp" : "isp",
                                        "admin_state" : "admin_state",
                                        "clid" : "clid",
                                        "max_downlink_bandwidth" : "max_downlink_bandwidth",
                                        "oper_state" : "oper_state",
                                        "internet_reachability" : "internet_reachability",
                                        "gateway_reachability" : "gateway_reachability",
                                        "port_name" : "port_name",
                                        "protocol" : "protocol",
                                        "endpoint_reachability" : "endpoint_reachability",
                                        "peering_status" : "peering_status",
                                        "vlan" : "vlan",
                                        "name" : "name",
                                        "max_uplink_bandwidth" : "max_uplink_bandwidth",
                                        "circuit_id" : "circuit_id",
                                        "id" : "id",
                                        "apn" : "apn"
                                      } ],
                                      "total_bb_interfaces" : 0,
                                      "total_dongle_interfaces" : 6,
                                      "version" : "version",
                                      "total_mpls_interfaces" : 5,
                                      "total_pppoe_interfaces" : 2,
                                      "name" : "name",
                                      "model" : "model",
                                      "id" : "id",
                                      "last_seen_at" : "last_seen_at",
                                      "total_wan_interfaces" : 7,
                                      "serial_no" : "serial_no",
                                      "total_interfaces" : 1,
                                      "total_lan_interfaces" : 5,
                                      "hardware" : {
                                        "total_memory" : "total_memory",
                                        "total_disk" : "total_disk",
                                        "num_emb_sim_slots" : "num_emb_sim_slots",
                                        "num_usb_ports" : "num_usb_ports",
                                        "num_network_ports" : "num_network_ports",
                                        "ports" : [ {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        }, {
                                          "logical_type" : "logical_type",
                                          "name" : "name",
                                          "duplex" : "duplex",
                                          "admin_state" : "admin_state",
                                          "slave_ports" : [ null, null ],
                                          "id" : "id",
                                          "oper_state" : "oper_state",
                                          "type" : "type",
                                          "speed" : "speed"
                                        } ],
                                        "num_cpu" : "num_cpu"
                                      }
                                    } ],
                                    "location" : "location",
                                    "id" : "id",
                                    "is_hub" : "is_hub"
                                  } ],
                                  "message" : "message"
                                }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetNetworkTopologyOKResponseBody

400

Bad Request response. GetNetworkTopologyOKResponseBody

422

Unprocessable Entity response. GetNetworkTopologyOKResponseBody

500

Internal Server Error response. GetNetworkTopologyOKResponseBody

GetAlerts paths ( pathsGetAlerts)
Get alerts

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetAlertsRequestBody (required)
Body Parameter —

Return type

GetAlertsOKResponseBody

Example data

Content-Type: application/json
			
{
  "alerts" : [ {
    "severity" : "critical",
    "log_id" : "log_id",
    "cnid" : "cnid",
    "module_sub_category" : "module_sub_category",
    "source_type" : "source_type",
    "message" : "message",
    "arguments" : "arguments",
    "id" : "id",
    "module_name" : "module_name",
    "state" : "state",
    "impact_duration" : "impact_duration",
    "alert_rule_id" : "alert_rule_id",
    "tracking_id" : "tracking_id",
    "timestamp" : "timestamp"
  }, {
    "severity" : "critical",
    "log_id" : "log_id",
    "cnid" : "cnid",
    "module_sub_category" : "module_sub_category",
    "source_type" : "source_type",
    "message" : "message",
    "arguments" : "arguments",
    "id" : "id",
    "module_name" : "module_name",
    "state" : "state",
    "impact_duration" : "impact_duration",
    "alert_rule_id" : "alert_rule_id",
    "tracking_id" : "tracking_id",
    "timestamp" : "timestamp"
  } ],
  "summary" : {
    "key" : 1
  },
  "session_id" : "session_id",
  "page_no" : "page_no",
  "message" : "message",
  "load_more" : "load_more"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetAlertsOKResponseBody

400

Bad Request response. GetAlertsOKResponseBody

422

Unprocessable Entity response. GetAlertsOKResponseBody

500

Internal Server Error response. GetAlertsOKResponseBody

GetAllCloudPortPaths paths ( pathsGetAllCloudPortPaths)
Get path health summary

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetAllCloudPortPathsRequestBody (required)
Body Parameter —

Return type

GetAllCloudPortPathsOKResponseBody

Example data

Content-Type: application/json
			
{
  "qs_range" : "qs_range",
  "up_down" : "up_down",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetAllCloudPortPathsOKResponseBody

400

Bad Request response. GetAllCloudPortPathsOKResponseBody

500

Internal Server Error response. GetAllCloudPortPathsOKResponseBody

GetCurrentPaths paths ( pathsGetCurrentPaths)
Get current paths

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetCurrentPathsRequestBody (required)
Body Parameter —

Return type

GetCurrentPathsOKResponseBody

Example data

Content-Type: application/json
			
{
  "data" : [ { }, { } ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetCurrentPathsOKResponseBody

400

Bad Request response. GetCurrentPathsOKResponseBody

500

Internal Server Error response. GetCurrentPathsOKResponseBody

GetPathsStatusCategory paths (pathsGetPathsStatusCategory)
Get paths for status category

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetQsRangeCategoryRequestBody (required)
Body Parameter —

Return type

GetPathsStatusCategoryOKResponseBody

Example data

Content-Type: application/json
{
              "cpe_list" : [ "cpe_list", "cpe_list" ],
              "up_down_paths" : "up_down_paths",
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetPathsStatusCategoryOKResponseBody

500

Internal Server Error response. GetPathsStatusCategoryOKResponseBody

GetPeerPaths paths (pathsGetPeerPaths)
Get paths with peers

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetPeerPathsRequestBody (required)
Body Parameter —

Return type

GetPeerPathsOKResponseBody

Example data

Content-Type: application/json
{
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetPeerPathsOKResponseBody

400

Bad Request response. GetPeerPathsOKResponseBody

422

Unprocessable Entity response. GetPeerPathsOKResponseBody

500

Internal Server Error response. GetPeerPathsOKResponseBody

GetPeers paths (pathsGetPeers)
Get peers

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetPeersRequestBody (required)
Body Parameter —

Return type

GetPeersOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "src_ip" : "src_ip",
                "dst_clid" : "dst_clid",
                "cnid" : "cnid",
                "src_clid" : "src_clid"
              }, {
                "src_ip" : "src_ip",
                "dst_clid" : "dst_clid",
                "cnid" : "cnid",
                "src_clid" : "src_clid"
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetPeersOKResponseBody

400

Bad Request response. GetPeersOKResponseBody

422

Unprocessable Entity response. GetPeersOKResponseBody

500

Internal Server Error response. GetPeersOKResponseBody

GetQsRangeCategory paths (pathsGetQsRangeCategory)
Get paths for QS range category

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetQsRangeCategoryRequestBody (required)
Body Parameter —

Return type

GetQsRangeCategoryOKResponseBody

Example data

Content-Type: application/json
{
  "qs_range" : "qs_range",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetQsRangeCategoryOKResponseBody

500

Internal Server Error response. GetQsRangeCategoryOKResponseBody

GetCloudPortScores scores (scoresGetCloudPortScores)
Get cloudport scores

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetUserScoresOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "ul_capacity_score" : 5.637377,
                "ul_capacity_health_score" : 5.962134,
                "quality_score" : 1.4658129,
                "created_at" : "created_at",
                "dl_capacity_score" : 6.0274563,
                "dl_capacity_health_score" : 0.8008282
              }, {
                "ul_capacity_score" : 5.637377,
                "ul_capacity_health_score" : 5.962134,
                "quality_score" : 1.4658129,
                "created_at" : "created_at",
                "dl_capacity_score" : 6.0274563,
                "dl_capacity_health_score" : 0.8008282
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetUserScoresOKResponseBody

400

Bad Request response. GetUserScoresOKResponseBody

422

Unprocessable Entity response. GetUserScoresOKResponseBody

500

Internal Server Error response. GetUserScoresOKResponseBody

GetCustomerScores scores (scoresGetCustomerScores)
Get customer scores

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetUserScoresOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "ul_capacity_score" : 5.637377,
                "ul_capacity_health_score" : 5.962134,
                "quality_score" : 1.4658129,
                "created_at" : "created_at",
                "dl_capacity_score" : 6.0274563,
                "dl_capacity_health_score" : 0.8008282
              }, {
                "ul_capacity_score" : 5.637377,
                "ul_capacity_health_score" : 5.962134,
                "quality_score" : 1.4658129,
                "created_at" : "created_at",
                "dl_capacity_score" : 6.0274563,
                "dl_capacity_health_score" : 0.8008282
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetUserScoresOKResponseBody

400

Bad Request response. GetUserScoresOKResponseBody

422

Unprocessable Entity response. GetUserScoresOKResponseBody

500

Internal Server Error response. GetUserScoresOKResponseBody

GetInterfaceScores scores (scoresGetInterfaceScores)
Get interface scores

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetInterfaceScoresRequestBody (required)
Body Parameter —

Return type

GetInterfaceScoresOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "drop" : 5.962134,
                "ul_capacity_score" : 9.301444,
                "delay" : 0.8008282,
                "jitter" : 5.637377,
                "ul_capacity_health_score" : 7.0614014,
                "quality_score" : 2.302136,
                "created_at" : "created_at",
                "dl_capacity_score" : 1.4658129,
                "dl_capacity_health_score" : 6.0274563
              }, {
                "drop" : 5.962134,
                "ul_capacity_score" : 9.301444,
                "delay" : 0.8008282,
                "jitter" : 5.637377,
                "ul_capacity_health_score" : 7.0614014,
                "quality_score" : 2.302136,
                "created_at" : "created_at",
                "dl_capacity_score" : 1.4658129,
                "dl_capacity_health_score" : 6.0274563
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetInterfaceScoresOKResponseBody

400

Bad Request response. GetInterfaceScoresOKResponseBody

422

Unprocessable Entity response. GetInterfaceScoresOKResponseBody

500

Internal Server Error response. GetInterfaceScoresOKResponseBody

GetUserScores scores (scoresGetUserScores)
Get user scores

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetUserScoresOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "ul_capacity_score" : 5.637377,
                "ul_capacity_health_score" : 5.962134,
                "quality_score" : 1.4658129,
                "created_at" : "created_at",
                "dl_capacity_score" : 6.0274563,
                "dl_capacity_health_score" : 0.8008282
              }, {
                "ul_capacity_score" : 5.637377,
                "ul_capacity_health_score" : 5.962134,
                "quality_score" : 1.4658129,
                "created_at" : "created_at",
                "dl_capacity_score" : 6.0274563,
                "dl_capacity_health_score" : 0.8008282
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetUserScoresOKResponseBody

400

Bad Request response. GetUserScoresOKResponseBody

422

Unprocessable Entity response. GetUserScoresOKResponseBody

500

Internal Server Error response. GetUserScoresOKResponseBody

GetCurrentLinkUtilizationSummary stats (statsGetCurrentLinkUtilizationSummary)
Get current link utilization summary

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetNetworkTopologyRequestBody (required)
Body Parameter —

Return type

GetCurrentLinkUtilizationSummaryOKResponseBody

Example data

Content-Type: application/json
{
              "data" : {
                "key" : [ "data", "data" ]
              },
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetCurrentLinkUtilizationSummaryOKResponseBody

400

Bad Request response. GetCurrentLinkUtilizationSummaryOKResponseBody

422

Unprocessable Entity response. GetCurrentLinkUtilizationSummaryOKResponseBody

500

Internal Server Error response. GetCurrentLinkUtilizationSummaryOKResponseBody

GetCurrentStats stats (statsGetCurrentStats)
Get current stats

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetCurrentStatsRequestBody (required)
Body Parameter —

Return type

GetCurrentStatsOKResponseBody

Example data

Content-Type: application/json
{
              "data" : {
                "key" : { }
              },
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetCurrentStatsOKResponseBody

400

Bad Request response. GetCurrentStatsOKResponseBody

422

Unprocessable Entity response. GetCurrentStatsOKResponseBody

500

Internal Server Error response. GetCurrentStatsOKResponseBody

GetDeviceInterfaceUtilizationStats stats (statsGetDeviceInterfaceUtilizationStats)
Get raw & aggregated stats for all interfaces on the device

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetDeviceInterfaceUtilizationStatsOKResponseBody

Example data

Content-Type: application/json
{
              "data" : {
                "key" : {
                  "key" : {
                    "peak_user_tx_bps" : 2.302136,
                    "all_tx_bps" : 6.0274563,
                    "peak_user_rx_bps" : 5.637377,
                    "peak_all_tx_bps" : 5.962134,
                    "interface_name" : "interface_name",
                    "created_at" : "created_at",
                    "user_rx_bps" : 7.0614014,
                    "all_rx_bps" : 0.8008282,
                    "user_tx_bps" : 9.301444,
                    "peak_all_rx_bps" : 1.4658129
                  }
                }
              },
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetDeviceInterfaceUtilizationStatsOKResponseBody

400

Bad Request response. GetDeviceInterfaceUtilizationStatsOKResponseBody

422

Unprocessable Entity response. GetDeviceInterfaceUtilizationStatsOKResponseBody

500

Internal Server Error response. GetDeviceInterfaceUtilizationStatsOKResponseBody

GetDeviceQoSStats stats (statsGetDeviceQoSStats)
Get cloudport utilization stats separated by QoS criticality and aggregated across all interfaces on the device

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetDeviceQoSStatsOKResponseBody

Example data

Content-Type: application/json
{
                  "data" : [ {
                    "peak_dropped_bps" : 5.637377,
                    "peak_dropped_pps" : 2.302136,
                    "avg_dropped_bps" : 0.8008282,
                    "peak_tx_pps" : 9.301444,
                    "avg_tx_bps" : 1.4658129,
                    "avg_tx_pps" : 5.962134,
                    "peak_tx_bps" : 7.0614014,
                    "criticality" : "critical",
                    "created_at" : "created_at",
                    "avg_dropped_pps" : 6.0274563
                  }, {
                    "peak_dropped_bps" : 5.637377,
                    "peak_dropped_pps" : 2.302136,
                    "avg_dropped_bps" : 0.8008282,
                    "peak_tx_pps" : 9.301444,
                    "avg_tx_bps" : 1.4658129,
                    "avg_tx_pps" : 5.962134,
                    "peak_tx_bps" : 7.0614014,
                    "criticality" : "critical",
                    "created_at" : "created_at",
                    "avg_dropped_pps" : 6.0274563
                  } ],
                  "message" : "message"
                }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetDeviceQoSStatsOKResponseBody

400

Bad Request response. GetDeviceQoSStatsOKResponseBody

422

Unprocessable Entity response. GetDeviceQoSStatsOKResponseBody

500

Internal Server Error response. GetDeviceQoSStatsOKResponseBody

GetDeviceResourceStats stats (statsGetDeviceResourceStats)
Get cloudport resource stats

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetDeviceResourceStatsOKResponseBody

Example data

Content-Type: application/json
{
  "data" : [ {
    "memory_free" : "memory_free",
    "disk_total" : "disk_total",
    "created_at" : "created_at",
    "disk_free" : "disk_free",
    "memory_total" : "memory_total",
    "cpu_temp" : "cpu_temp",
    "cpu_util" : "cpu_util"
  }, {
    "memory_free" : "memory_free",
    "disk_total" : "disk_total",
    "created_at" : "created_at",
    "disk_free" : "disk_free",
    "memory_total" : "memory_total",
    "cpu_temp" : "cpu_temp",
    "cpu_util" : "cpu_util"
  } ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetDeviceResourceStatsOKResponseBody

400

Bad Request response. GetDeviceResourceStatsOKResponseBody

422

Unprocessable Entity response. GetDeviceResourceStatsOKResponseBody

500

Internal Server Error response. GetDeviceResourceStatsOKResponseBody

GetDeviceUtilizationStats stats (statsGetDeviceUtilizationStats)
Get device utilization stats aggregated across all interfaces on the device

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetDeviceUtilizationStatsOKResponseBody

Example data

Content-Type: application/json
{
  "data" : [ {
    "peak_user_tx_bps" : 2.302136,
    "all_tx_bps" : 6.0274563,
    "peak_user_rx_bps" : 5.637377,
    "peak_all_tx_bps" : 5.962134,
    "created_at" : "created_at",
    "user_rx_bps" : 7.0614014,
    "all_rx_bps" : 0.8008282,
    "user_tx_bps" : 9.301444,
    "peak_all_rx_bps" : 1.4658129
  }, {
    "peak_user_tx_bps" : 2.302136,
    "all_tx_bps" : 6.0274563,
    "peak_user_rx_bps" : 5.637377,
    "peak_all_tx_bps" : 5.962134,
    "created_at" : "created_at",
    "user_rx_bps" : 7.0614014,
    "all_rx_bps" : 0.8008282,
    "user_tx_bps" : 9.301444,
    "peak_all_rx_bps" : 1.4658129
  } ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetDeviceUtilizationStatsOKResponseBody

400

Bad Request response. GetDeviceUtilizationStatsOKResponseBody

422

Unprocessable Entity response. GetDeviceUtilizationStatsOKResponseBody

500

Internal Server Error response. GetDeviceUtilizationStatsOKResponseBody

GetInterfaceQoSStats stats (statsGetInterfaceQoSStats)
Get interface utilization stats separated by QoS criticality

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetInterfaceScoresRequestBody (required)
Body Parameter —

Return type

GetDeviceQoSStatsOKResponseBody

Example data

Content-Type: application/json
{
  "data" : [ {
    "peak_dropped_bps" : 5.637377,
    "peak_dropped_pps" : 2.302136,
    "avg_dropped_bps" : 0.8008282,
    "peak_tx_pps" : 9.301444,
    "avg_tx_bps" : 1.4658129,
    "avg_tx_pps" : 5.962134,
    "peak_tx_bps" : 7.0614014,
    "criticality" : "critical",
    "created_at" : "created_at",
    "avg_dropped_pps" : 6.0274563
  }, {
    "peak_dropped_bps" : 5.637377,
    "peak_dropped_pps" : 2.302136,
    "avg_dropped_bps" : 0.8008282,
    "peak_tx_pps" : 9.301444,
    "avg_tx_bps" : 1.4658129,
    "avg_tx_pps" : 5.962134,
    "peak_tx_bps" : 7.0614014,
    "criticality" : "critical",
    "created_at" : "created_at",
    "avg_dropped_pps" : 6.0274563
  } ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetDeviceQoSStatsOKResponseBody

400

Bad Request response. GetDeviceQoSStatsOKResponseBody

422

Unprocessable Entity response. GetDeviceQoSStatsOKResponseBody

500

Internal Server Error response. GetDeviceQoSStatsOKResponseBody

GetInterfaceUtilizationStats stats (statsGetInterfaceUtilizationStats)
Get interface utilization stats

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetInterfaceScoresRequestBody (required)
Body Parameter —

Return type

GetInterfaceUtilizationStatsOKResponseBody

Example data

Content-Type: application/json
{
  "data" : [ {
    "peak_user_tx_bps" : 2.302136,
    "all_tx_bps" : 6.0274563,
    "peak_user_rx_bps" : 5.637377,
    "peak_all_tx_bps" : 5.962134,
    "interface_name" : "interface_name",
    "created_at" : "created_at",
    "user_rx_bps" : 7.0614014,
    "all_rx_bps" : 0.8008282,
    "user_tx_bps" : 9.301444,
    "peak_all_rx_bps" : 1.4658129
  }, {
    "peak_user_tx_bps" : 2.302136,
    "all_tx_bps" : 6.0274563,
    "peak_user_rx_bps" : 5.637377,
    "peak_all_tx_bps" : 5.962134,
    "interface_name" : "interface_name",
    "created_at" : "created_at",
    "user_rx_bps" : 7.0614014,
    "all_rx_bps" : 0.8008282,
    "user_tx_bps" : 9.301444,
    "peak_all_rx_bps" : 1.4658129
  } ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetInterfaceUtilizationStatsOKResponseBody

400

Bad Request response. GetInterfaceUtilizationStatsOKResponseBody

422

Unprocessable Entity response. GetInterfaceUtilizationStatsOKResponseBody

500

Internal Server Error response. GetInterfaceUtilizationStatsOKResponseBody

GetDeviceStatus status (statusGetDeviceStatus)
Get cloudport status

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetUserScoresRequestBody (required)
Body Parameter —

Return type

GetDeviceStatusOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "created_at" : "created_at",
                "status" : true
              }, {
                "created_at" : "created_at",
                "status" : true
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetDeviceStatusOKResponseBody

400

Bad Request response. GetDeviceStatusOKResponseBody

422

Unprocessable Entity response. GetDeviceStatusOKResponseBody

500

Internal Server Error response. GetDeviceStatusOKResponseBody

GetInterfaceStatus status (statusGetInterfaceStatus)
Get interface status

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GetInterfaceScoresRequestBody (required)
Body Parameter —

Return type

GetInterfaceStatusOKResponseBody

Example data

Content-Type: application/json
{
              "data" : [ {
                "created_at" : "created_at",
                "link_status" : true
              }, {
                "created_at" : "created_at",
                "link_status" : true
              } ],
              "message" : "message"
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK response. GetInterfaceStatusOKResponseBody

400

Bad Request response. GetInterfaceStatusOKResponseBody

422

Unprocessable Entity response. GetInterfaceStatusOKResponseBody

500

Internal Server Error response. GetInterfaceStatusOKResponseBody

Download gen/http/openapi.json (swagger/swagger/swagger.json)
JSON document containing the API swagger definition

Responses

200

File downloaded

Models

[ Jump to Methods ]
Alert
alert_rule_id (optional)
String Alert Rule ID
arguments (optional)
String Arguments for the Raw Event
cnid (optional)
String CloudPort ID
id (optional)
String Alert ID
impact_duration (optional)
String Impact Duration
log_id (optional)
String Log ID
message (optional)
String Alert Message
module_name (optional)
String Module Name
module_sub_category (optional)
String Module Sub-Category
severity (optional)
String Alert Severity
Enum:
critical
high
medium
low
source_type (optional)
String Source Type
state (optional)
String Alert State
timestamp (optional)
String Timestamp of the Alert
tracking_id (optional)
String Tracking ID
CloudPort Information
hardware (optional)
Hardware
id (optional)
String CloudPort ID
interfaces (optional)
array[Interface] Interfaces in the CloudPort
last_seen_at (optional)
String Last Seen Timestamp
model (optional)
String CloudPort Model
name (optional)
String CloudPort Name
serial_no (optional)
String CloudPort Serial Number
total_bb_interfaces (optional)
Long Total Broadband Interfaces in the CloudPort format: int64
total_dongle_interfaces (optional)
Long Total Dongle Interfaces in the CloudPort format: int64
total_interfaces (optional)
Long Total Interfaces in the CloudPort format: int64
total_lan_interfaces (optional)
Long Total LAN Interfaces in the CloudPort format: int64
total_mpls_interfaces (optional)
Long Total MPLS Interfaces in the CloudPort format: int64
total_pppoe_interfaces (optional)
Long Total PPPoE Interfaces in the CloudPort format: int64
total_wan_interfaces (optional)
Long Total WAN Interfaces in the CloudPort format: int64
version (optional)
String CloudPort Version
Cluster Health Summary
core_name (optional)
String Core Name
delegation (optional)
String Delegation
insights_name (optional)
String Insights Name
instances (optional)
map[String, Instance] Map of Instance Type & Instance Health Summary
is_master (optional)
Boolean Is Master
switch_timestamp (optional)
String Switch Timestamp
total_elapsed_time (optional)
Long Total Elapsed Time format: int64
DeviceResourceStat
cpu_temp (optional)
String CPU Temperature
cpu_util (optional)
String CPU Utilization
created_at (optional)
String Created At
disk_free (optional)
String Disk Utilization
disk_total (optional)
String Disk Available
memory_free (optional)
String Memory Utilization
memory_total (optional)
String Memory Available
DeviceStatus
created_at (optional)
String Created At
status (optional)
Boolean Status
DeviceUtilizationStat
all_rx_bps (optional)
Float Total Rx Bps format: float
all_tx_bps (optional)
Float Total Tx Bps format: float
created_at (optional)
String Created At
peak_all_rx_bps (optional)
Float Peak Total Rx Bps format: float
peak_all_tx_bps (optional)
Float Peak Total Tx Bps format: float
peak_user_rx_bps (optional)
Float Peak User RX Bps format: float
peak_user_tx_bps (optional)
Float Peak User TX Bps format: float
user_rx_bps (optional)
Float User RX Bps format: float
user_tx_bps (optional)
Float User TX Bps format: float
Aggregated Endpoint Record from Flow Records
cumulative (optional)
Long Cumulative value format: int64
cumulative_percent (optional)
Long Cumulative percentage value format: int64
download (optional)
Long Download value format: int64
download_percent (optional)
Long Download percentage value format: int64
name (optional)
String Endpoint Identifier
upload (optional)
Long Upload value format: int64
upload_percent (optional)
Long Upload percentage value format: int64
alerts (optional)
array[Alert] Alerts
load_more (optional)
String Load more data
message (optional)
String Message for success/error if any
page_no (optional)
String Page number
session_id (optional)
String Session ID for chunked data
summary (optional)
map[String, Long] Summary of alerts based on severity format: int64
alert_state (optional)
String Alert state to filter
end
Date End timestamp of alerts format: date-time
filters (optional)
String JSON-encoded filters for alerts. Currently support only 'LogId'
page (optional)
Integer Page number format: int32
scope_id
Long ID of scope format: int64
scope_type
String Type of scope
Enum:
customer
user
cloudport
interface
session_id (optional)
String Session ID for chunked data
start
Date Start timestamp of alerts format: date-time
message (optional)
String Message for error if any
qs_range (optional)
String
up_down (optional)
String
scope_id (optional)
Long ID of scope format: int64
scope_type (optional)
String Type of scope
Enum:
customer
user
cloudport
interface
clusters (optional)
array[Cluster] Cluster health summaries
message (optional)
String Message for success/error if any
data (optional)
map[String, array[String]] Link Utilization Summary
message (optional)
String Message for error if any
data (optional)
array[PathRecord] Path records
message (optional)
String Message for error if any
cnid (optional)
String CloudPort ID to filter
data (optional)
map[String, PathRecord] Device Stats
message (optional)
String Message for error if any
cnid
array[String] Comma-separated CloudPort IDs to fetch
data (optional)
map[String, map[String, InterfaceUtilizationStat]] Interface Utilization Stats
message (optional)
String Message for error if any
data (optional)
array[QoSStat] QoS Stats
message (optional)
String Message for error if any
data (optional)
array[DeviceResourceStat] Device Resource Stats
message (optional)
String Message for error if any
data (optional)
array[DeviceStatus] Device Status
message (optional)
String Message for error if any
data (optional)
array[DeviceUtilizationStat] Device Utilization Stats
message (optional)
String Message for error if any
flows (optional)
array[PathRecord] Flow records
from_time (optional)
String Start timestamp of returned flow records
load_more (optional)
String Load more data
message (optional)
String Message for success/error if any
session_id (optional)
String Session ID for chunked data
to_time (optional)
String End timestamp of returned flow records
cnid (optional)
String CloudPort ID to filter
customer_id
Long Customer ID format: int64
from
Date Start timestamp of flow records format: date-time
is_chunk
Integer Whether to fetch chunked data format: int32
page
Integer Page number format: int32
scope_id (optional)
Long ID of scope format: int64
scope_type (optional)
String Type of scope
Enum:
customer
user
cloudport
interface
session_id
String Session ID for chunked data
to
Date End timestamp of flow records format: date-time
data (optional)
array[InterfaceScore] Interface Scores
message (optional)
String Message for error if any
from
Date Start timestamp of scores format: date-time
scope_id
Long ID of scope format: int64
scope_name (optional)
String Name of interface when scope_type is interface
scope_type
String Type of scope
Enum:
customer
user
cloudport
interface
to
Date End timestamp of scores format: date-time
data (optional)
array[InterfaceStatus] Interface Status
message (optional)
String Message for error if any
data (optional)
array[InterfaceUtilizationStat] QoS Stats
message (optional)
String Message for error if any
data (optional)
array[Site] Network Topology
message (optional)
String Message for error if any
scope_id
Long ID of scope format: int64
scope_type
String Type of scope
Enum:
customer
user
cloudport
interface
cpe_list (optional)
array[String] List of CloudPort IDs
message (optional)
String Message for error if any
up_down_paths (optional)
String
message (optional)
String Message for error if any
cnids
array[String] Comma-separated CloudPort IDs to filter
dst_clids (optional)
String Destination CloudPort Link IDs to filter
end
Date End timestamp of flow records format: date-time
src_clids (optional)
String Source CloudPort Link IDs to filter
start
Date Start timestamp of flow records format: date-time
data (optional)
array[PeerRecord] Peer records
message (optional)
String Message for error if any
clids (optional)
String CloudPort Link IDs to filter
cnid
String CloudPort ID to filter
end
Date End timestamp of flow records format: date-time
start
Date Start timestamp of flow records format: date-time
message (optional)
String Message for error if any
qs_range (optional)
String
category (optional)
String QS range category
scope_id (optional)
Long ID of scope format: int64
scope_type (optional)
String Type of scope
Enum:
customer
user
cloudport
interface
message (optional)
String Message for success/error if any
sorted_apps (optional)
map[String, EndpointRecord] Map of Aspects to Application Records
version (optional)
String Version of the data
message (optional)
String Message for success/error if any
sorted_flows (optional)
map[String, EndpointRecord] Map of Aspects to Endpoint Records
version (optional)
String Version of the data
app_type
String Application type to search
Enum:
all
saas
enterprise
web_cat
cnid (optional)
String CloudPort ID to filter
customer_id
Long Customer ID format: int64
from
Date Start timestamp of flow records format: date-time
metric (optional)
String Flow metric to filter & search
order_by
String Order by the cumulative, upload or download value
Enum:
cumulative
upload
download
scope_id (optional)
Long ID of scope format: int64
scope_type (optional)
String Type of scope
Enum:
customer
user
cloudport
interface
to
Date End timestamp of flow records format: date-time
data (optional)
array[Score] Scores
message (optional)
String Message for error if any
from
Date Start timestamp of scores format: date-time
scope_id
Long ID of scope format: int64
scope_type
String Type of scope
Enum:
customer
user
cloudport
interface
to
Date End timestamp of scores format: date-time
Hardware Information
num_cpu (optional)
String Number of CPUs
num_emb_sim_slots (optional)
String Number of Embedded SIM Slots
num_network_ports (optional)
String Number of Network Ports
num_usb_ports (optional)
String Number of USB Ports
ports (optional)
array[Port] Ports in the Hardware
total_disk (optional)
String Total Disk
total_memory (optional)
String Total Memory
Instance Health Summary
cnid (optional)
String Instance ID
cpu (optional)
map[String, String] Map of Important CPU Metrics
disks (optional)
map[String, String] Disk Usage of Important Disks
memory (optional)
map[String, String] Map of Important Memory Metrics
Interface Information
admin_state (optional)
String Interface Admin State
apn (optional)
String Interface APN
circuit_id (optional)
String Interface Circuit ID
clid (optional)
String Interface CLID
endpoint_reachability (optional)
String Interface Endpoint Reachability
gateway_reachability (optional)
String Interface Gateway Reachability
id (optional)
String Interface ID
internet_reachability (optional)
String Interface Internet Reachability
isp (optional)
String Interface ISP
max_downlink_bandwidth (optional)
String Interface Max Downlink Bandwidth
max_uplink_bandwidth (optional)
String Interface Max Uplink Bandwidth
name (optional)
String Interface Name
oper_state (optional)
String Interface Operational State
peering_status (optional)
String Interface Peering Status
port_name (optional)
String Interface Port Name
port_type (optional)
String Interface Port Type
primary_ip (optional)
String Interface Primary IP
protocol (optional)
String Interface Protocol
role (optional)
String Interface Role
secondary_ip (optional)
array[String] Interface Secondary IPs
vlan (optional)
String Interface VLAN
InterfaceScore
created_at (optional)
String Created At
delay (optional)
Float Delay format: float
dl_capacity_health_score (optional)
Float Downlink Capacity Health Score format: float
dl_capacity_score (optional)
Float Downlink Capacity Score format: float
drop (optional)
Float Drop format: float
jitter (optional)
Float Jitter format: float
quality_score (optional)
Float Quality Score format: float
ul_capacity_health_score (optional)
Float Uplink Capacity Health Score format: float
ul_capacity_score (optional)
Float Uplink Capacity Score format: float
InterfaceStatus
created_at (optional)
String Created At
link_status (optional)
Boolean Link Status
InterfaceUtilizationStat
all_rx_bps (optional)
Float Total Rx Bps format: float
all_tx_bps (optional)
Float Total Tx Bps format: float
created_at (optional)
String Created At
interface_name (optional)
String Interface Name
peak_all_rx_bps (optional)
Float Peak Total Rx Bps format: float
peak_all_tx_bps (optional)
Float Peak Total Tx Bps format: float
peak_user_rx_bps (optional)
Float Peak User RX Bps format: float
peak_user_tx_bps (optional)
Float Peak User TX Bps format: float
user_rx_bps (optional)
Float User RX Bps format: float
user_tx_bps (optional)
Float User TX Bps format: float
Path Record
Peer Record for CloudPort
cnid (optional)
String CloudPort ID
dst_clid (optional)
String Destination CloudPort Link ID
src_clid (optional)
String Source CloudPort Link ID
src_ip (optional)
String Source CloudPort IP
Port Information
admin_state (optional)
String Port Admin State
duplex (optional)
String Port Duplexity
id (optional)
String Port ID
logical_type (optional)
String Port Logical Type
master_port (optional)
Port
name (optional)
String Port Name
oper_state (optional)
String Port Operational State
slave_ports (optional)
array[Port] Slave Ports
speed (optional)
String Port Speed
type (optional)
String Port Type
QoSStat
avg_dropped_bps (optional)
Float Avg Dropped Bps format: float
avg_dropped_pps (optional)
Float Avg Dropped Pps format: float
avg_tx_bps (optional)
Float Avg Tx Bps format: float
avg_tx_pps (optional)
Float Avg Tx Pps format: float
created_at (optional)
String Created At
criticality (optional)
String QoS Criticality
Enum:
critical
high
medium
low
peak_dropped_bps (optional)
Float Peak Dropped Bps format: float
peak_dropped_pps (optional)
Float Peak Dropped Pps format: float
peak_tx_bps (optional)
Float Peak Tx Bps format: float
peak_tx_pps (optional)
Float Peak Tx Pps format: float
Score
created_at (optional)
String Created At
dl_capacity_health_score (optional)
Float Downlink Capacity Health Score format: float
dl_capacity_score (optional)
Float Downlink Capacity Score format: float
quality_score (optional)
Float Quality Score format: float
ul_capacity_health_score (optional)
Float Uplink Capacity Health Score format: float
ul_capacity_score (optional)
Float Uplink Capacity Score format: float
Site Information
cloudports (optional)
array[CloudPort] CloudPort in the Site
id (optional)
String Site ID
is_hub (optional)
String Is HUB Site
location (optional)
String Site Location
name (optional)
String Site Name
profile (optional)
SiteProfile
spoc (optional)
String Site SPOC
Site Profile Information
business_hours (optional)
String Business Hours
business_weekdays (optional)
String Business Weekdays
id (optional)
String Profile ID
name (optional)
String Profile Name