/api/settings/get

Use this interface to get configuration information.

System configuration viewing permissions are required.

Prototype

Protocol HTTP/HTTPS GET
URL ip[:port]/api/settings/get
Content-Type Response: Content-Type: application/json

Request Cookies

Parameter Description
mwcloud-sid A string that is used to identify current logged-in user.
mwcloud-uid Current logged-in username.
Request URL parameters

None.

Request Example

GET /api/settings/get
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=utf-8
Content-Length: xx
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;

Response Parameters

Response Header
Parameter Description
Content-Type Value: 'application/json; charset=UTF-8'
Response Body
Parameter Description
result Refer to Result code
security Refer to Security Settings
web Refer to Web Settings
rtmp Refer to RTMP Settings
srt Refer to SRT Settings
pwd-rule Refer to Password policy rules
expired-time Session timeout for user login in minutes.
Security Settings
Parameter Description
enable-code Whether to enable invitation code.
code-value Invitation code
Web Settings
Parameter Description
http-port http port
enable-https Whether to enable https.
https-port https port
is-cert-valid Validity of CA certificate
is-cert-key-valid Validity of CA private key
RTMP Settings
Parameter Description
port Port
SRT Settings
Parameter Description
port Port
pb-key-len Refer to Cipher Settings, Obtaining configuration will not return the key field.
Cipher Settings
Parameter Description
0 unencrypted
16 AES-128
24 AES-192
32 AES-256

Response Example

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
content-length: xx
{
    "cert-key-path": "/data/cert/control-hub.pem",
    "cert-path": "/data/cert/control-hub.crt",
    "expired-time": 30,
    "pwd-rule": {
        "chk-name": 0,
        "length": 0,
        "number": 0,
        "special": 0,
        "uppercase": 0
    },
    "result": 0,
    "rtmp": {
        "port": 1935
    },
    "security": {
        "code-value": "0165",
        "enable-code": false
    },
    "srt": {
        "passphrase": "1234567890",
        "pb-key-len": 16,
        "port": 80
    },
    "web": {
        "enable-https": true,
        "http-port": 80,
        "https-port": 443,
        "is-cert-key-valid": true,
        "is-cert-valid": true
    }
}

results matching ""

    No results matching ""

    results matching ""

      No results matching ""