System API

  • Published on Oct 21, 2025
  • 4 minute(s) read
Prev Next

The System API base URL is http://{swXtch-ctrl-ip}:{port}

Monitoring

monitoring

  • Get component information to include Metric totals, SLP data, Stream Links or stream data as well as hardware data regarding the components related to a cloudSwXtch.

Endpoint:

<base_url>/swx/monitoring/components

Request:

Empty

Response:

json

Example Response →

$ curl 172.51.128.132/swx/monitoring/components -d '{ "swxtchAddresses": [ "172.51.128.88", "172.51.128.132" ] }'
{
    "172.51.128.126": {
        "metrics": {
            "ha": {
                "aggregations": null,
                "streams": []
            },
            "slp": {
                "rx": {},
                "tx": {}
            },
            "streamLinks": {},
            "totals": {
                "ens6": {
                    "rxCounters": {
                        "byteCount": 0,
                        "packetCount": 0
                    },
                    "rxDropCounters": {
                        "byteCount": 0,
                        "packetCount": 0
                    },
                    "rxRates": {
                        "byteCount": 0,
                        "packetCount": 0
                    },
                    "timestamp": 1759165816261739276,
                    "txCounters": {
                        "byteCount": 0,
                        "packetCount": 0
                    },
                    "txDropCounters": {
                        "byteCount": 0,
                        "packetCount": 0
                    },
                    "txRates": {
                        "byteCount": 0,
                        "packetCount": 0
                    }
                }
            }
        },
        "state": {
            "componentKindCode": "xnic",
            "environment": {
                "cloudName": "AWS",
                "hostname": "ip-172-51-128-126",
                "instanceTypeName": "m6i.2xlarge",
                "osDistribution": "Ubuntu 24.04",
                "regionName": "us-west-1"
            },
            "hardware": {
                "nics": {
                    "ens5": {
                        "broadcastIp": "172.51.128.255",
                        "driverName": "ena",
                        "index": 2,
                        "ip": "172.51.128.126",
                        "mac": "06:ad:0c:49:a9:87",
                        "masterOf": null,
                        "mtu": 9001,
                        "name": "ens5",
                        "pciAddress": "0000:00:05.0",
                        "publicIp": null,
                        "subnetMask": "255.255.255.0",
                        "subnetPrefix": "172.51.128.0/24",
                        "vpc": "vpc-029879464f8431389"
                    },
                    "ens6": {
                        "broadcastIp": "172.51.144.255",
                        "driverName": "ena",
                        "index": 3,
                        "ip": "172.51.144.149",
                        "mac": "06:d4:55:e3:4b:21",
                        "masterOf": null,
                        "mtu": 3900,
                        "name": "ens6",
                        "pciAddress": "0000:00:06.0",
                        "publicIp": null,
                        "subnetMask": "255.255.255.0",
                        "subnetPrefix": "172.51.144.0/24",
                        "vpc": "vpc-029879464f8431389"
                    },
                "vpcs": {
                    "ens5": "vpc-029879464f8431389",
                    "ens6": "vpc-029879464f8431389"
                }
            },
            "id": "172.51.128.126",
            "name": "ip-172-51-128-126"
        }
.
.