MI_HTTP module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module provides a HTTP transport layer implementation for OpenSIPS’s Management Interface.
Dependencies
Section titled “Dependencies”External Libraries or Applications
Section titled “External Libraries or Applications”None
OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- httpd module.
Exported Parameters
Section titled “Exported Parameters”root(string)
Section titled “root(string)”Specifies the root path for HTTP requests: http://[opensips_IP]:[opensips_httpd_port]/[root]
The default value is “mi”.
...modparam("mi_http", "root", "opensips_mi")...trace_destination (string)
Section titled “trace_destination (string)”Trace destination as defined in the tracing module. Currently the only tracing module is proto_hep. This is where traced mi messages will go.
**WARNING:**A tracing module must be loaded in order for this parameter to work. (for example proto_hep).
Default value is none(not defined).
...modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport=tcp;version=3")
modparam("mi_http", "trace_destination", "hep_dest")...trace_bwlist (string)
Section titled “trace_bwlist (string)”Filter traced mi commands based on a blacklist or a whitelist. trace_destination must be defined for this parameter to have any purpose. Whitelists can be defined using ‘w’ or ‘W’, blacklists using ‘b’ or ‘B’. The type is separate by the actual blacklist by ’:’. The mi commands in the list must be separated by ’,’.
Defining a blacklists means all the commands that are not blacklisted will be traced. Defining a whitelist means all the commands that are not whitelisted will not be traced. WARNING: One can’t define both a whitelist and a blacklist. Only one of them is allowed. Defining the parameter a second time will just overwrite the first one.
Default value is none(not defined).
...## blacklist ps and which mi commands## all the other commands shall be tracedmodparam("mi_http", "trace_bwlist", "b: ps, which")...## allow only sip_trace mi command## all the other commands will not be tracedmodparam("mi_http", "trace_bwlist", "w: sip_trace")...Exported Functions
Section titled “Exported Functions”No function exported to be used from configuration file.
Known Issues
Section titled “Known Issues”Commands with large responses (like ul_dump) will fail if the configured size of the httpd buffer is to small (or if there isn’t enough pkg memory configured).
Future realeases of the httpd module will address this issue.
Examples
Section titled “Examples”This is an example showing the JSON-RPC request and reply over HTTP for the “ps” MI command.
POST /mi HTTP/1.1Accept: application/jsonContent-Type: application/jsonHost: example.net
{"jsonrpc":"2.0","method":"ps","id":10}
HTTP/1.1 200 OKContent-Length: 317Content-Type: application/jsonDate: Fri, 01 Nov 2013 12:00:00 GMT
{"jsonrpc":"2.0","result":{"Processes":[{"ID":0,"PID":9467,"Type":"attendant"},{"ID":1,"PID":9468,"Type":"HTTPD127.0.0.1:8008"},{"ID":3,"PID":9470,"Type":"time_keeper"},{"ID":4,"PID":9471,"Type":"timer"},{"ID":5,"PID":9472,"Type":"SIPreceiverudp:127.0.0.1:5060"},{"ID":7,"PID":9483,"Type":"Timerhandler"},]},"id":10}Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Vlad Patrascu (@rvlad-patrascu) | 42 | 5 | 1006 | 1650 |
| 2. | Stephane Alnet | 20 | 5 | 1270 | 238 |
| 3. | Razvan Crainea (@razvancrainea) | 17 | 13 | 219 | 82 |
| 4. | Ionut Ionita (@ionutrazvanionita) | 14 | 10 | 280 | 59 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | 11 | 6 | 204 | 138 |
| 6. | Liviu Chircu (@liviuchircu) | 9 | 7 | 31 | 37 |
| 7. | Stefan Darius (@dariusstefan) | 7 | 4 | 190 | 27 |
| 8. | Vlad Paiu (@vladpaiu) | 5 | 3 | 9 | 4 |
| 9. | Peter Lemenkov (@lemenkov) | 3 | 1 | 1 | 1 |
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Dec 2013 - Jun 2026 |
| 3. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jul 2014 - Apr 2019 |
| 5. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 6. | Liviu Chircu (@liviuchircu) | Jul 2014 - Jun 2018 |
| 7. | Ionut Ionita (@ionutrazvanionita) | May 2016 - Feb 2017 |
| 8. | Vlad Paiu (@vladpaiu) | Nov 2013 - Jan 2016 |
| 9. | Stephane Alnet | Oct 2013 - Nov 2013 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Ionut Ionita (@ionutrazvanionita), Bogdan-Andrei Iancu (@bogdan-iancu), Stephane Alnet.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0