Hosts

Per-inbound override endpoints. Each enabled host renders one extra subscription link/proxy with its own address/port/TLS, superseding the legacy externalProxy array. All endpoints under /panel/api/hosts.

List every host across all inbounds, grouped by inbound then ordered by sort order.

GET

/panel/api/hosts/list

GET

/panel/api/hosts/list

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?array<>

Example Request

curl -X GET 'https://example.com/panel/api/hosts/list'

Example Request

curl -X GET 'https://example.com/panel/api/hosts/list'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    {
      "allowInsecure": false,
      "alpn": [
        ""
      ],
      "cipherSuites": "",
      "echConfigList": "",
      "excludeFromSubTypes": [
        ""
      ],
      "finalMask": "",
      "fingerprint": "",
      "groupId": "",
      "hostHeader": "",
      "hosts": [
        ""
      ],
      "inboundIds": [
        0
      ],
      "isDisabled": false,
      "isHidden": false,
      "keepSniBlank": false,
      "mihomoIpVersion": "dual",
      "mihomoX25519": false,
      "muxParams": "",
      "nodeGuids": [
        ""
      ],
      "overrideSniFromAddress": false,
      "path": "",
      "pinnedPeerCertSha256": [
        ""
      ],
      "port": 0,
      "randomCount": 1,
      "remark": "",
      "security": "same",
      "serverDescription": "",
      "shuffleHost": false,
      "sni": "",
      "sniSharedRandom": false,
      "snis": [
        ""
      ],
      "sockoptParams": "",
      "sortOrder": 0,
      "tags": [
        ""
      ],
      "verifyPeerCertByName": "",
      "vlessRoute": ""
    }
  ]
}

{  "success": true,  "obj": [    {      "allowInsecure": false,      "alpn": [        ""      ],      "cipherSuites": "",      "echConfigList": "",      "excludeFromSubTypes": [        ""      ],      "finalMask": "",      "fingerprint": "",      "groupId": "",      "hostHeader": "",      "hosts": [        ""      ],      "inboundIds": [        0      ],      "isDisabled": false,      "isHidden": false,      "keepSniBlank": false,      "mihomoIpVersion": "dual",      "mihomoX25519": false,      "muxParams": "",      "nodeGuids": [        ""      ],      "overrideSniFromAddress": false,      "path": "",      "pinnedPeerCertSha256": [        ""      ],      "port": 0,      "randomCount": 1,      "remark": "",      "security": "same",      "serverDescription": "",      "shuffleHost": false,      "sni": "",      "sniSharedRandom": false,      "snis": [        ""      ],      "sockoptParams": "",      "sortOrder": 0,      "tags": [        ""      ],      "verifyPeerCertByName": "",      "vlessRoute": ""    }  ]}

List every host row with its numeric id, for id-based pickers such as the per-client host rule override.

GET

/panel/api/hosts/raw

GET

/panel/api/hosts/raw

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?array<>

Example Request

curl -X GET 'https://example.com/panel/api/hosts/raw'

Example Request

curl -X GET 'https://example.com/panel/api/hosts/raw'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    {
      "address": "cdn.example.com",
      "allowInsecure": false,
      "alpn": [
        ""
      ],
      "cipherSuites": "",
      "createdAt": 0,
      "echConfigList": "",
      "excludeFromSubTypes": [
        ""
      ],
      "finalMask": "",
      "fingerprint": "",
      "groupId": "",
      "hostHeader": "",
      "id": 1,
      "inboundId": 1,
      "isDisabled": false,
      "isHidden": false,
      "keepSniBlank": false,
      "mihomoIpVersion": "dual",
      "mihomoX25519": false,
      "muxParams": null,
      "nodeGuids": [
        ""
      ],
      "overrideSniFromAddress": false,
      "path": "",
      "pinnedPeerCertSha256": [
        ""
      ],
      "port": 8443,
      "randomCount": 1,
      "remark": "cdn-front",
      "security": "same",
      "serverDescription": "",
      "shuffleHost": false,
      "sni": "",
      "sniSharedRandom": false,
      "snis": [
        ""
      ],
      "sockoptParams": null,
      "sortOrder": 0,
      "tags": [
        ""
      ],
      "updatedAt": 0,
      "verifyPeerCertByName": "",
      "vlessRoute": "443"
    }
  ]
}

{  "success": true,  "obj": [    {      "address": "cdn.example.com",      "allowInsecure": false,      "alpn": [        ""      ],      "cipherSuites": "",      "createdAt": 0,      "echConfigList": "",      "excludeFromSubTypes": [        ""      ],      "finalMask": "",      "fingerprint": "",      "groupId": "",      "hostHeader": "",      "id": 1,      "inboundId": 1,      "isDisabled": false,      "isHidden": false,      "keepSniBlank": false,      "mihomoIpVersion": "dual",      "mihomoX25519": false,      "muxParams": null,      "nodeGuids": [        ""      ],      "overrideSniFromAddress": false,      "path": "",      "pinnedPeerCertSha256": [        ""      ],      "port": 8443,      "randomCount": 1,      "remark": "cdn-front",      "security": "same",      "serverDescription": "",      "shuffleHost": false,      "sni": "",      "sniSharedRandom": false,      "snis": [        ""      ],      "sockoptParams": null,      "sortOrder": 0,      "tags": [        ""      ],      "updatedAt": 0,      "verifyPeerCertByName": "",      "vlessRoute": "443"    }  ]}

Fetch a single host group by Group ID.

GET

/panel/api/hosts/get/{groupId}

GET

/panel/api/hosts/get/{groupId}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

groupId*string

Host Group ID.

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?

Example Request

curl -X GET 'https://example.com/panel/api/hosts/get/string'

Example Request

curl -X GET 'https://example.com/panel/api/hosts/get/string'

Example ResponseSchema200

{
  "success": true,
  "obj": {
    "allowInsecure": false,
    "alpn": [
      ""
    ],
    "cipherSuites": "",
    "echConfigList": "",
    "excludeFromSubTypes": [
      ""
    ],
    "finalMask": "",
    "fingerprint": "",
    "groupId": "",
    "hostHeader": "",
    "hosts": [
      ""
    ],
    "inboundIds": [
      0
    ],
    "isDisabled": false,
    "isHidden": false,
    "keepSniBlank": false,
    "mihomoIpVersion": "dual",
    "mihomoX25519": false,
    "muxParams": "",
    "nodeGuids": [
      ""
    ],
    "overrideSniFromAddress": false,
    "path": "",
    "pinnedPeerCertSha256": [
      ""
    ],
    "port": 0,
    "randomCount": 1,
    "remark": "",
    "security": "same",
    "serverDescription": "",
    "shuffleHost": false,
    "sni": "",
    "sniSharedRandom": false,
    "snis": [
      ""
    ],
    "sockoptParams": "",
    "sortOrder": 0,
    "tags": [
      ""
    ],
    "verifyPeerCertByName": "",
    "vlessRoute": ""
  }
}

{  "success": true,  "obj": {    "allowInsecure": false,    "alpn": [      ""    ],    "cipherSuites": "",    "echConfigList": "",    "excludeFromSubTypes": [      ""    ],    "finalMask": "",    "fingerprint": "",    "groupId": "",    "hostHeader": "",    "hosts": [      ""    ],    "inboundIds": [      0    ],    "isDisabled": false,    "isHidden": false,    "keepSniBlank": false,    "mihomoIpVersion": "dual",    "mihomoX25519": false,    "muxParams": "",    "nodeGuids": [      ""    ],    "overrideSniFromAddress": false,    "path": "",    "pinnedPeerCertSha256": [      ""    ],    "port": 0,    "randomCount": 1,    "remark": "",    "security": "same",    "serverDescription": "",    "shuffleHost": false,    "sni": "",    "sniSharedRandom": false,    "snis": [      ""    ],    "sockoptParams": "",    "sortOrder": 0,    "tags": [      ""    ],    "verifyPeerCertByName": "",    "vlessRoute": ""  }}

Fetch one inbound's hosts, grouped by host group.

GET

/panel/api/hosts/byInbound/{inboundId}

GET

/panel/api/hosts/byInbound/{inboundId}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

inboundId*integer

Inbound ID.

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?array<>

Example Request

curl -X GET 'https://example.com/panel/api/hosts/byInbound/0'

Example Request

curl -X GET 'https://example.com/panel/api/hosts/byInbound/0'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    {
      "allowInsecure": false,
      "alpn": [
        ""
      ],
      "cipherSuites": "",
      "echConfigList": "",
      "excludeFromSubTypes": [
        ""
      ],
      "finalMask": "",
      "fingerprint": "",
      "groupId": "",
      "hostHeader": "",
      "hosts": [
        ""
      ],
      "inboundIds": [
        0
      ],
      "isDisabled": false,
      "isHidden": false,
      "keepSniBlank": false,
      "mihomoIpVersion": "dual",
      "mihomoX25519": false,
      "muxParams": "",
      "nodeGuids": [
        ""
      ],
      "overrideSniFromAddress": false,
      "path": "",
      "pinnedPeerCertSha256": [
        ""
      ],
      "port": 0,
      "randomCount": 1,
      "remark": "",
      "security": "same",
      "serverDescription": "",
      "shuffleHost": false,
      "sni": "",
      "sniSharedRandom": false,
      "snis": [
        ""
      ],
      "sockoptParams": "",
      "sortOrder": 0,
      "tags": [
        ""
      ],
      "verifyPeerCertByName": "",
      "vlessRoute": ""
    }
  ]
}

{  "success": true,  "obj": [    {      "allowInsecure": false,      "alpn": [        ""      ],      "cipherSuites": "",      "echConfigList": "",      "excludeFromSubTypes": [        ""      ],      "finalMask": "",      "fingerprint": "",      "groupId": "",      "hostHeader": "",      "hosts": [        ""      ],      "inboundIds": [        0      ],      "isDisabled": false,      "isHidden": false,      "keepSniBlank": false,      "mihomoIpVersion": "dual",      "mihomoX25519": false,      "muxParams": "",      "nodeGuids": [        ""      ],      "overrideSniFromAddress": false,      "path": "",      "pinnedPeerCertSha256": [        ""      ],      "port": 0,      "randomCount": 1,      "remark": "",      "security": "same",      "serverDescription": "",      "shuffleHost": false,      "sni": "",      "sniSharedRandom": false,      "snis": [        ""      ],      "sockoptParams": "",      "sortOrder": 0,      "tags": [        ""      ],      "verifyPeerCertByName": "",      "vlessRoute": ""    }  ]}

Distinct, sorted set of tags used across all hosts.

GET

/panel/api/hosts/tags

GET

/panel/api/hosts/tags

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

Example Request

curl -X GET 'https://example.com/panel/api/hosts/tags'

Example Request

curl -X GET 'https://example.com/panel/api/hosts/tags'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    "CDN",
    "EU",
    "FAST"
  ]
}

{  "success": true,  "obj": [    "CDN",    "EU",    "FAST"  ]}

Create a host group on inbounds.

POST

/panel/api/hosts/add

POST

/panel/api/hosts/add

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?array<>

Example Request

curl -X POST 'https://example.com/panel/api/hosts/add' \
  -H 'Content-Type: application/json' \
  -d '{
  "inboundIds": [
    1
  ],
  "remark": "cdn-front",
  "hosts": [
    "cdn.example.com"
  ],
  "port": 8443,
  "security": "same",
  "tags": [
    "CDN"
  ]
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/add' \  -H 'Content-Type: application/json' \  -d '{  "inboundIds": [    1  ],  "remark": "cdn-front",  "hosts": [    "cdn.example.com"  ],  "port": 8443,  "security": "same",  "tags": [    "CDN"  ]}'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    {
      "address": "cdn.example.com",
      "allowInsecure": false,
      "alpn": [
        ""
      ],
      "cipherSuites": "",
      "createdAt": 0,
      "echConfigList": "",
      "excludeFromSubTypes": [
        ""
      ],
      "finalMask": "",
      "fingerprint": "",
      "groupId": "",
      "hostHeader": "",
      "id": 1,
      "inboundId": 1,
      "isDisabled": false,
      "isHidden": false,
      "keepSniBlank": false,
      "mihomoIpVersion": "dual",
      "mihomoX25519": false,
      "muxParams": null,
      "nodeGuids": [
        ""
      ],
      "overrideSniFromAddress": false,
      "path": "",
      "pinnedPeerCertSha256": [
        ""
      ],
      "port": 8443,
      "randomCount": 1,
      "remark": "cdn-front",
      "security": "same",
      "serverDescription": "",
      "shuffleHost": false,
      "sni": "",
      "sniSharedRandom": false,
      "snis": [
        ""
      ],
      "sockoptParams": null,
      "sortOrder": 0,
      "tags": [
        ""
      ],
      "updatedAt": 0,
      "verifyPeerCertByName": "",
      "vlessRoute": "443"
    }
  ]
}

{  "success": true,  "obj": [    {      "address": "cdn.example.com",      "allowInsecure": false,      "alpn": [        ""      ],      "cipherSuites": "",      "createdAt": 0,      "echConfigList": "",      "excludeFromSubTypes": [        ""      ],      "finalMask": "",      "fingerprint": "",      "groupId": "",      "hostHeader": "",      "id": 1,      "inboundId": 1,      "isDisabled": false,      "isHidden": false,      "keepSniBlank": false,      "mihomoIpVersion": "dual",      "mihomoX25519": false,      "muxParams": null,      "nodeGuids": [        ""      ],      "overrideSniFromAddress": false,      "path": "",      "pinnedPeerCertSha256": [        ""      ],      "port": 8443,      "randomCount": 1,      "remark": "cdn-front",      "security": "same",      "serverDescription": "",      "shuffleHost": false,      "sni": "",      "sniSharedRandom": false,      "snis": [        ""      ],      "sockoptParams": null,      "sortOrder": 0,      "tags": [        ""      ],      "updatedAt": 0,      "verifyPeerCertByName": "",      "vlessRoute": "443"    }  ]}

Replace a host group’s content.

POST

/panel/api/hosts/update/{groupId}

POST

/panel/api/hosts/update/{groupId}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

groupId*string

Host Group ID.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?array<>

Example Request

curl -X POST 'https://example.com/panel/api/hosts/update/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "inboundIds": [
    1
  ],
  "remark": "cdn-front",
  "hosts": [
    "cdn.example.com"
  ],
  "port": 8443,
  "security": "same",
  "tags": [
    "CDN"
  ]
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/update/string' \  -H 'Content-Type: application/json' \  -d '{  "inboundIds": [    1  ],  "remark": "cdn-front",  "hosts": [    "cdn.example.com"  ],  "port": 8443,  "security": "same",  "tags": [    "CDN"  ]}'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    {
      "address": "cdn.example.com",
      "allowInsecure": false,
      "alpn": [
        ""
      ],
      "cipherSuites": "",
      "createdAt": 0,
      "echConfigList": "",
      "excludeFromSubTypes": [
        ""
      ],
      "finalMask": "",
      "fingerprint": "",
      "groupId": "",
      "hostHeader": "",
      "id": 1,
      "inboundId": 1,
      "isDisabled": false,
      "isHidden": false,
      "keepSniBlank": false,
      "mihomoIpVersion": "dual",
      "mihomoX25519": false,
      "muxParams": null,
      "nodeGuids": [
        ""
      ],
      "overrideSniFromAddress": false,
      "path": "",
      "pinnedPeerCertSha256": [
        ""
      ],
      "port": 8443,
      "randomCount": 1,
      "remark": "cdn-front",
      "security": "same",
      "serverDescription": "",
      "shuffleHost": false,
      "sni": "",
      "sniSharedRandom": false,
      "snis": [
        ""
      ],
      "sockoptParams": null,
      "sortOrder": 0,
      "tags": [
        ""
      ],
      "updatedAt": 0,
      "verifyPeerCertByName": "",
      "vlessRoute": "443"
    }
  ]
}

{  "success": true,  "obj": [    {      "address": "cdn.example.com",      "allowInsecure": false,      "alpn": [        ""      ],      "cipherSuites": "",      "createdAt": 0,      "echConfigList": "",      "excludeFromSubTypes": [        ""      ],      "finalMask": "",      "fingerprint": "",      "groupId": "",      "hostHeader": "",      "id": 1,      "inboundId": 1,      "isDisabled": false,      "isHidden": false,      "keepSniBlank": false,      "mihomoIpVersion": "dual",      "mihomoX25519": false,      "muxParams": null,      "nodeGuids": [        ""      ],      "overrideSniFromAddress": false,      "path": "",      "pinnedPeerCertSha256": [        ""      ],      "port": 8443,      "randomCount": 1,      "remark": "cdn-front",      "security": "same",      "serverDescription": "",      "shuffleHost": false,      "sni": "",      "sniSharedRandom": false,      "snis": [        ""      ],      "sockoptParams": null,      "sortOrder": 0,      "tags": [        ""      ],      "updatedAt": 0,      "verifyPeerCertByName": "",      "vlessRoute": "443"    }  ]}

Delete a host group.

POST

/panel/api/hosts/del/{groupId}

POST

/panel/api/hosts/del/{groupId}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

groupId*string

Host Group ID.

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

Example Request

curl -X POST 'https://example.com/panel/api/hosts/del/string'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/del/string'

Example ResponseSchema200

{
  "success": true,
  "msg": "string",
  "obj": null
}

{  "success": true,  "msg": "string",  "obj": null}

Enable or disable a host group.

POST

/panel/api/hosts/setEnable/{groupId}

POST

/panel/api/hosts/setEnable/{groupId}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

groupId*string

Host Group ID.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

Example Request

curl -X POST 'https://example.com/panel/api/hosts/setEnable/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "enable": true
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/setEnable/string' \  -H 'Content-Type: application/json' \  -d '{  "enable": true}'

Example ResponseSchema200

{
  "success": true,
  "msg": "string",
  "obj": null
}

{  "success": true,  "msg": "string",  "obj": null}

Set host group sort order by the position of each groupId in the array. IDs must be unique and refer to existing groups; omitted groups follow in their previous order.

POST

/panel/api/hosts/reorder

POST

/panel/api/hosts/reorder

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

Example Request

curl -X POST 'https://example.com/panel/api/hosts/reorder' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "abc-123",
    "def-456"
  ]
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/reorder' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "abc-123",    "def-456"  ]}'

Example ResponseSchema200

{
  "success": true,
  "msg": "string",
  "obj": null
}

{  "success": true,  "msg": "string",  "obj": null}

Add a host group to inbounds (same as /add).

POST

/panel/api/hosts/bulk/add

POST

/panel/api/hosts/bulk/add

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?array<>

Example Request

curl -X POST 'https://example.com/panel/api/hosts/bulk/add' \
  -H 'Content-Type: application/json' \
  -d '{
  "inboundIds": [
    1,
    2
  ],
  "hosts": [
    "cdn.example.com",
    "cdn2.example.com:443"
  ],
  "remark": "Cloudflare CDN",
  "port": 0,
  "security": "same",
  "isDisabled": false
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/bulk/add' \  -H 'Content-Type: application/json' \  -d '{  "inboundIds": [    1,    2  ],  "hosts": [    "cdn.example.com",    "cdn2.example.com:443"  ],  "remark": "Cloudflare CDN",  "port": 0,  "security": "same",  "isDisabled": false}'

Example ResponseSchema200

{
  "success": true,
  "obj": [
    {
      "address": "cdn.example.com",
      "allowInsecure": false,
      "alpn": [
        ""
      ],
      "cipherSuites": "",
      "createdAt": 0,
      "echConfigList": "",
      "excludeFromSubTypes": [
        ""
      ],
      "finalMask": "",
      "fingerprint": "",
      "groupId": "",
      "hostHeader": "",
      "id": 1,
      "inboundId": 1,
      "isDisabled": false,
      "isHidden": false,
      "keepSniBlank": false,
      "mihomoIpVersion": "dual",
      "mihomoX25519": false,
      "muxParams": null,
      "nodeGuids": [
        ""
      ],
      "overrideSniFromAddress": false,
      "path": "",
      "pinnedPeerCertSha256": [
        ""
      ],
      "port": 8443,
      "randomCount": 1,
      "remark": "cdn-front",
      "security": "same",
      "serverDescription": "",
      "shuffleHost": false,
      "sni": "",
      "sniSharedRandom": false,
      "snis": [
        ""
      ],
      "sockoptParams": null,
      "sortOrder": 0,
      "tags": [
        ""
      ],
      "updatedAt": 0,
      "verifyPeerCertByName": "",
      "vlessRoute": "443"
    }
  ]
}

{  "success": true,  "obj": [    {      "address": "cdn.example.com",      "allowInsecure": false,      "alpn": [        ""      ],      "cipherSuites": "",      "createdAt": 0,      "echConfigList": "",      "excludeFromSubTypes": [        ""      ],      "finalMask": "",      "fingerprint": "",      "groupId": "",      "hostHeader": "",      "id": 1,      "inboundId": 1,      "isDisabled": false,      "isHidden": false,      "keepSniBlank": false,      "mihomoIpVersion": "dual",      "mihomoX25519": false,      "muxParams": null,      "nodeGuids": [        ""      ],      "overrideSniFromAddress": false,      "path": "",      "pinnedPeerCertSha256": [        ""      ],      "port": 8443,      "randomCount": 1,      "remark": "cdn-front",      "security": "same",      "serverDescription": "",      "shuffleHost": false,      "sni": "",      "sniSharedRandom": false,      "snis": [        ""      ],      "sockoptParams": null,      "sortOrder": 0,      "tags": [        ""      ],      "updatedAt": 0,      "verifyPeerCertByName": "",      "vlessRoute": "443"    }  ]}

Enable or disable many host groups in one call.

POST

/panel/api/hosts/bulk/setEnable

POST

/panel/api/hosts/bulk/setEnable

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

Example Request

curl -X POST 'https://example.com/panel/api/hosts/bulk/setEnable' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "abc-123",
    "def-456"
  ],
  "enable": false
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/bulk/setEnable' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "abc-123",    "def-456"  ],  "enable": false}'

Example ResponseSchema200

{
  "success": true,
  "msg": "string",
  "obj": null
}

{  "success": true,  "msg": "string",  "obj": null}

Delete many host groups in one call.

POST

/panel/api/hosts/bulk/del

POST

/panel/api/hosts/bulk/del

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

Example Request

curl -X POST 'https://example.com/panel/api/hosts/bulk/del' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "abc-123",
    "def-456"
  ]
}'

Example Request

curl -X POST 'https://example.com/panel/api/hosts/bulk/del' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "abc-123",    "def-456"  ]}'

Example ResponseSchema200

{
  "success": true,
  "msg": "string",
  "obj": null
}

{  "success": true,  "msg": "string",  "obj": null}

List every host across all inbounds, grouped by inbound then ordered by sort order.Copy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

List every host row with its numeric id, for id-based pickers such as the per-client host rule override.Copy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Fetch a single host group by Group ID.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Fetch one inbound's hosts, grouped by host group.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Distinct, sorted set of tags used across all hosts.Copy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Create a host group on inbounds.Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Replace a host group’s content.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a host group.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Enable or disable a host group.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Set host group sort order by the position of each groupId in the array. IDs must be unique and refer to existing groups; omitted groups follow in their previous order.Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Add a host group to inbounds (same as /add).Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Enable or disable many host groups in one call.Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete many host groups in one call.Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

List every host across all inbounds, grouped by inbound then ordered by sort order.

Authorization

Response Body

List every host row with its numeric id, for id-based pickers such as the per-client host rule override.

Authorization

Response Body

Fetch a single host group by Group ID.

Authorization

Path Parameters

Response Body

Fetch one inbound's hosts, grouped by host group.

Authorization

Path Parameters

Response Body

Distinct, sorted set of tags used across all hosts.

Authorization

Response Body

Create a host group on inbounds.

Authorization

Request Body

Response Body

Replace a host group’s content.

Authorization

Path Parameters

Request Body

Response Body

Delete a host group.

Authorization

Path Parameters

Response Body

Enable or disable a host group.

Authorization

Path Parameters

Request Body

Response Body

Set host group sort order by the position of each groupId in the array. IDs must be unique and refer to existing groups; omitted groups follow in their previous order.

Authorization

Request Body

Response Body

Add a host group to inbounds (same as /add).

Authorization

Request Body

Response Body

Enable or disable many host groups in one call.

Authorization

Request Body

Response Body

Delete many host groups in one call.

Authorization

Request Body

Response Body