CINXE.COM

<!DOCTYPE html> <html> <head>  <script async="async" src="https://consent.trustarc.com/notice?domain=f5.com&c=teconsent&js=nj&noticeType=bb&text=true&gtm=1" crossorigin=""></script>  <script src="https://mktg.tags.f5.com/nginx-unit/prod/utag.sync.js"></script>  <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" />  <meta property="og:type" content="website"> <meta property="og:url" content="https://unit.nginx.org/statusapi/"> <meta property="og:title" content="NGINX Unit: Status API"> <meta content="Query global and per-application usage statistics from NGINX Unit." name="og:description" /> <meta property="og:image" content="http://unit.nginx.org/_static/logo.png?e39b3bbae06cd8bdb5a7814270161b52"> <meta property="og:image:secure_url" content="https://unit.nginx.org/_static/logo.png?e39b3bbae06cd8bdb5a7814270161b52"> <meta property="og:image:width" content="988"> <meta property="og:image:height" content="357"> <meta property="og:image:alt" content="NGINX Unit logo" />  <meta property="twitter:card" content="summary_large_image"> <style> /* open-sans-regular - latin_latin-ext */ @font-face { font-display: swap; font-family: 'Open Sans'; font-style: normal; font-weight: 400; src: local('OpenSans'), local('Open Sans'), local('Open Sans Regular'), local('OpenSans-Regular'), url('../_static/open-sans-v40-latin_latin-ext-regular.woff2?058e68d126ca347a4db54933db4738db') format('woff2'); } /* open-sans-italic - latin_latin-ext */ @font-face { font-display: swap; font-family: 'Open Sans'; font-style: italic; font-weight: 400; src: local('OpenSansItalic'), local('Open Sans Italic'), local('OpenSans Italic'), local('OpenSans-Italic'), url('../_static/open-sans-v40-latin_latin-ext-italic.woff2?86b58c2ae26455092651312b8582674f') format('woff2'); } /* open-sans-700 - latin_latin-ext */ @font-face { font-display: swap; font-family: 'Open Sans'; font-style: normal; font-weight: 700; src: local('OpenSansBold'), local('Open Sans Bold'), local('OpenSans Bold'), local('OpenSans-Bold'), url('../_static/open-sans-v40-latin_latin-ext-700.woff2?40654e941d643aead74c5d6a56a38c6b') format('woff2'); } /* open-sans-700italic - latin_latin-ext */ @font-face { font-display: swap; font-family: 'Open Sans'; font-style: italic; font-weight: 700; src: local('OpenSansBoldItalic'), local('Open Sans Bold Italic'), local('OpenSans Bold Italic'), local('OpenSans-BoldItalic'), local('OpenSans-Bold-Italic'), url('../_static/open-sans-v40-latin_latin-ext-700italic.woff2?e4fada57efe79e0fb447a7dc076a568b') format('woff2'); } </style> <link rel="stylesheet" href="../_static/style.css?02b1052daea25a810283ecaa29bc2462" /> <link rel="icon" href="../_static/icon.png?26255dfe9094cf47412c8b5d3757467b" /> <link rel="alternate" type="application/rss+xml" title="Subscribe to NGINX Unit News" href="https://unit.nginx.org/rss.xml" /> <script async src="../_static/script.js?8dc8ff30c396ce882326156b1581000a"></script> <link rel="next" title="CLI (unitctl)" href="../unitctl/" /> <link rel="prev" title="SSL/TLS certificates" href="../certificates/" /> <title>Status API — NGINX Unit</title> </head> <body>  <script type="text/javascript"> (function(a,b,c,d) { a='//mktg.tags.f5.com/nginx-unit/prod/utag.js'; b=document;c='script';d=b.createElement(c);d.src=a; d.type='text/java'+c;d.async=true; a=b.getElementsByTagName(c)[0];a.parentNode.insertBefore(d,a)})(); </script>   <div id="main"> <div id="side"> <h1> <a href="../"> <img src="../_static/logo.svg?ea753eb2210f855447af3b2367898f85" alt="NGINX Unit" /> </a> <div id="version_link" title="Released on Feb 26, 2025"> <a style="text-decoration:none;" href="../news/2025/unit-1.34.2-released/">v. 1.34.2</a> </div> </h1> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../">About</a></li> <li class="toctree-l1"><a class="reference internal" href="../keyfeatures/">Key features</a></li> <li class="toctree-l1"><a class="reference internal" href="../news/">News</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation/">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="../controlapi/">Control API</a></li> <li class="toctree-l1"><a class="reference internal" href="../configuration/">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="../scripting/">Scripting</a></li> <li class="toctree-l1"><a class="reference internal" href="../certificates/">SSL/TLS certificates</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Status API</a></li> <li class="toctree-l1"><a class="reference internal" href="../unitctl/">CLI (unitctl)</a></li> <li class="toctree-l1"><a class="reference internal" href="../howto/">How-to</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a></li> <li class="toctree-l1"><a class="reference internal" href="../community/">Community</a></li> </ul> </div> <div id="content"> <div class="section" id="status-api"> <h1>Status API<a class="headerlink" href="#status-api" title="Permalink to this heading">§</a></h1> Unit collects information about the loaded language models, as well as instance- and app-wide metrics, and makes them available via the GET-only /status section of the <a class="reference internal" href="../controlapi/#configuration-api">control API</a>: <table border="1" class="docutils align-default"> <colgroup> <col width="50%" /> <col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Option</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>modules</td> <td>Object; lists currently loaded language modules.</td> </tr> <tr class="row-odd"><td>connections</td> <td>Object; lists per-instance connection statistics.</td> </tr> <tr class="row-even"><td>requests</td> <td>Object; lists per-instance request statistics.</td> </tr> <tr class="row-odd"><td>applications</td> <td>Object; each option item lists per-app process and request statistics.</td> </tr> </tbody> </table> Example: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "modules": { "python": [ { "version": "3.12.3", "lib": "/opt/unit/modules/python.unit.so" }, { "version": "3.8", "lib": "/opt/unit/modules/python-3.8.unit.so" } ], "php": { "version": "8.3.4", "lib": "/opt/unit/modules/php.unit.so" } }, "connections": { "accepted": 1067, "active": 13, "idle": 4, "closed": 1050 }, "requests": { "total": 1307 }, "applications": { "wp": { "processes": { "running": 14, "starting": 0, "idle": 4 }, "requests": { "active": 10 } } } } </pre></div> </div> Each item in the modules object lists one of the currently loaded language modules, the installed version (or versions) of the module, and the path to the module file: <table border="1" class="docutils align-default"> <colgroup> <col width="50%" /> <col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Option</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>name</td> <td>String; language module name.</td> </tr> <tr class="row-odd"><td>version</td> <td>String; language module version. If multiple versions are loaded, the list contains multiple items.</td> </tr> <tr class="row-even"><td>lib</td> <td>String; path to the language module file.</td> </tr> </tbody> </table> The connections object offers the following Unit instance metrics: <table border="1" class="docutils align-default"> <colgroup> <col width="50%" /> <col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Option</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>accepted</td> <td>Integer; total accepted connections during the instance’s lifetime.</td> </tr> <tr class="row-odd"><td>active</td> <td>Integer; current active connections for the instance.</td> </tr> <tr class="row-even"><td>idle</td> <td>Integer; current idle connections for the instance.</td> </tr> <tr class="row-odd"><td>closed</td> <td>Integer; total closed connections during the instance’s lifetime.</td> </tr> </tbody> </table> Example: <div class="highlight-json notranslate"><div class="highlight"><pre>"connections": { "accepted": 1067, "active": 13, "idle": 4, "closed": 1050 } </pre></div> </div> <div class="admonition note"> Note For details of instance connection management, refer to <a class="reference internal" href="../configuration/#configuration-stngs">Settings</a>. </div> The requests object currently exposes a single instance-wide metric: <table border="1" class="docutils align-default"> <colgroup> <col width="50%" /> <col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Option</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>total</td> <td>Integer; total non-API requests during the instance’s lifetime.</td> </tr> </tbody> </table> Example: <div class="highlight-json notranslate"><div class="highlight"><pre>"requests": { "total": 1307 } </pre></div> </div> Each item in applications describes an app currently listed in the /config/applications <a class="reference internal" href="../configuration/#configuration-applications">section</a>: <table border="1" class="docutils align-default"> <colgroup> <col width="50%" /> <col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Option</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>processes</td> <td>Object; lists per-app process statistics.</td> </tr> <tr class="row-odd"><td>requests</td> <td>Object; similar to /status/requests, but includes only the data for a specific app.</td> </tr> </tbody> </table> Example: <div class="highlight-json notranslate"><div class="highlight"><pre>"applications": { "wp": { "processes": { "running": 14, "starting": 0, "idle": 4 }, "requests": { "active": 10 } } } </pre></div> </div> The processes object exposes the following per-app metrics: <table border="1" class="docutils align-default"> <colgroup> <col width="50%" /> <col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Option</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>running</td> <td>Integer; current running app processes.</td> </tr> <tr class="row-odd"><td>starting</td> <td>Integer; current starting app processes.</td> </tr> <tr class="row-even"><td>idle</td> <td>Integer; current idle app processes.</td> </tr> </tbody> </table> Example: <div class="highlight-json notranslate"><div class="highlight"><pre>"processes": { "running": 14, "starting": 0, "idle": 4 } </pre></div> </div> <div class="admonition note"> Note For details of per-app process management, refer to <a class="reference internal" href="../configuration/#configuration-proc-mgmt">Process management</a>. </div> </div> <div class="nxt_edit_link"><a href="https://github.com/nginx/unit-docs/edit/main/source/statusapi.rst"><div></div>Edit this page</a></div> <div class="nxt_discuss_link"><a href="https://github.com/nginx/unit/discussions/"><div></div>Discuss on GitHub</a></div> © 2017-2025 <a href="https://www.nginx.com/">NGINX, Inc.</a>   </div> </div>  <div id="consent_blackbar" style="position:fixed;top:0px;width:100%">  </body> </html>