littlebalalafairy/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2025-06-08 01:22:07 +08:00
Code Issues Packages Projects Releases Wiki Activity
sing-box/docs/configuration/service/ssm-api.md
世界 905a2ded93
Add SSM API service
2025-06-06 23:17:46 +08:00

869 B
Raw Blame History

icon
icon
material/new-box

!!! question "Since sing-box 1.12.0"

SSM API

SSM API service is a RESTful API server for managing Shadowsocks servers.

See https://github.com/Shadowsocks-NET/shadowsocks-specs/blob/main/2023-1-shadowsocks-server-management-api-v1.md

Structure

{
  "type": "ssm-api",
  
  ... // Listen Fields
  
  "servers": {},
  "tls": {}
}

Listen Fields

See Listen Fields for details.

Fields

servers

==Required==

A mapping Object from HTTP endpoints to Shadowsocks Inbound tags.

Selected Shadowsocks inbounds must be configured with managed enabled.

Example:

{
  "servers": {
    "/": "ss-in"
  }
}

tls

TLS configuration, see TLS.