# SSM API - sing-box
The universal proxy platform.
Author: nekohasekai

跳转至

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.