Skip to main content

System Status REST API

Premium


This page describes how to use the System Status REST API that is provided by the Management Center for the Pro Edition of Eclipse Mosquitto (MMC).

info

Before sending a command request, make sure that you have been authenticated.

info

Application Tokens REST API can be accessed by a user with any role.

System Status REST API​

System status information can be accessed via an HTTP request:

  • GET /api/system/status - get information about the currently connected brokers

Example of the reply:

{
    "development-inspect": {
        "_name": "development-inspect",
        "$SYS": {
            "broker": {
                "version": "mosquitto version 2.5.3",
                "uptime": "843746 seconds",
                "clients": {
                    "total": "3",
                    "maximum": "5",
                    "inactive": "0",
                    "disconnected": "0",
                    "active": "3",
                    "connected": "3",
                    "expired": "0"
                },
                "load": {
                    "messages": {
                        "received": {
                            "1min": "8.93",
                            "5min": "9.15",
                            "15min": "8.58"
                        },
                        "sent": {
                            "1min": "82.81",
                            "5min": "83.73",
                            "15min": "81.88"
                        }
                    },
                    "publish": {
                        "dropped": {
                            "1min": "0.06",
                            "5min": "0.20",
                            "15min": "0.07"
                        },
                        "received": {
                            "1min": "0.37",
                            "5min": "1.12",
                            "15min": "0.72"
                        },
                        "sent": {
                            "1min": "61.90",
                            "5min": "63.24",
                            "15min": "61.66"
                        }
                    },
                    "bytes": {
                        "received": {
                            "1min": "75.54",
                            "5min": "191.06",
                            "15min": "107.60"
                        },
                        "sent": {
                            "1min": "3774.06",
                            "5min": "8594.32",
                            "15min": "5158.98"
                        }
                    },
                    "sockets": {
                        "1min": "60.73",
                        "5min": "59.89",
                        "15min": "59.74"
                    },
                    "connections": {
                        "1min": "0.06",
                        "5min": "0.20",
                        "15min": "0.07"
                    }
                },
                "messages": {
                    "stored": "53",
                    "received": "113475",
                    "sent": "3921733"
                },
                "store": {
                    "messages": {
                        "count": "53",
                        "bytes": "238"
                    }
                },
                "subscriptions": {
                    "count": "9"
                },
                "shared_subscriptions": {
                    "count": "0"
                },
                "retained messages": {
                    "count": "53"
                },
                "publish": {
                    "messages": {
                        "dropped": "0",
                        "received": "66",
                        "sent": "3808332"
                    },
                    "bytes": {
                        "received": "8172",
                        "sent": "23197228"
                    }
                },
                "bytes": {
                    "received": "247823",
                    "sent": "160895750"
                },
                "packet": {
                    "out": {
                        "count": "0",
                        "bytes": "0"
                    }
                }
            }
        }
    },
    "Rocky": {
        "_name": "Rocky",
        "$SYS": {
            "broker": {
                "version": "mosquitto version 2.5.3",
                "uptime": "2490609 seconds",
                "clients": {
                    "total": "3",
                    "maximum": "4",
                    "inactive": "0",
                    "disconnected": "0",
                    "active": "3",
                    "connected": "3",
                    "expired": "0"
                },
                "load": {
                    "messages": {
                        "received": {
                            "1min": "356.65",
                            "5min": "356.22",
                            "15min": "355.54"
                        },
                        "sent": {
                            "1min": "471.21",
                            "5min": "467.90",
                            "15min": "454.37"
                        }
                    },
                    "publish": {
                        "dropped": {
                            "1min": "0.06",
                            "5min": "0.20",
                            "15min": "0.07"
                        },
                        "received": {
                            "1min": "0.06",
                            "5min": "0.47",
                            "15min": "0.73"
                        },
                        "sent": {
                            "1min": "96.58",
                            "5min": "95.78",
                            "15min": "85.23"
                        }
                    },
                    "bytes": {
                        "received": {
                            "1min": "20171.73",
                            "5min": "20184.75",
                            "15min": "20161.37"
                        },
                        "sent": {
                            "1min": "3732.60",
                            "5min": "5481.63",
                            "15min": "5133.72"
                        }
                    },
                    "sockets": {
                        "1min": "353.72",
                        "5min": "352.54",
                        "15min": "352.38"
                    },
                    "connections": {
                        "1min": "353.77",
                        "5min": "352.53",
                        "15min": "352.28"
                    }
                },
                "messages": {
                    "stored": "55",
                    "received": "14673902",
                    "sent": "31528971"
                },
                "store": {
                    "messages": {
                        "count": "55",
                        "bytes": "319"
                    }
                },
                "subscriptions": {
                    "count": "18"
                },
                "shared_subscriptions": {
                    "count": "0"
                },
                "retained messages": {
                    "count": "55"
                },
                "heap": {
                    "current": "18446744073706449616",
                    "maximum": "18446744073709551568"
                },
                "publish": {
                    "messages": {
                        "dropped": "0",
                        "received": "26629",
                        "sent": "16881943"
                    },
                    "bytes": {
                        "received": "3510283",
                        "sent": "141539116"
                    }
                },
                "bytes": {
                    "received": "834144242",
                    "sent": "808390777"
                },
                "packet": {
                    "out": {
                        "count": "0",
                        "bytes": "0"
                    }
                }
            }
        }
    }
}