Skip to content
HTTP Tweak Client API / Documentation
Client API keys

Reference API v1

Connection examples

Choose a tunnel and copy a complete server or tweak document.

Client API · Manage saved panel configurations

On this page

Choose a protocol below to see a complete server or tweak body. All hostnames, passwords, public keys, and profiles are illustrative. Replace them with working values for your infrastructure.

How to use a sample

Client API: send a server body to POST /api/v1/configs/{config_key}/servers, or a tweak body to POST /api/v1/configs/{config_key}/tweaks, using your Client API key.

Business API: choose the configuration view to get a complete generation request containing that sample. Send it to POST /api/business/v1/config/generate with your Business API key. Examples that only demonstrate a shared tweak need your compatible server added before they are useful for connecting.

Start with the Client API quickstart if this is your first request. Some samples deliberately show multiple endpoint choices or advanced methods; the connection format explains each part.

Sample library

The library below uses the application's shared example definitions and converts them to the public JSON format. Expand a sample, choose the body you need, and copy it. With JavaScript disabled, all sample bodies remain available.

OpenVPN TCP Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "OpenVPN",
    "tunnel": {
        "family": "openvpn",
        "variant": "tcp"
    },
    "settings": {
        "endpoint": {
            "hosts": [
                "vpn.example.com"
            ],
            "ports": [
                1194
            ]
        },
        "profile": "client\ndev tun\nauth-user-pass\nremote-cert-tls server\n",
        "credentials": {
            "username": "demo",
            "password": "secret"
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "OpenVPN TCP",
    "tunnels": {
        "openvpn": {
            "variants": [
                "tcp"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "OpenVPN TCP",
    "servers": [
        {
            "name": "OpenVPN",
            "tunnel": {
                "family": "openvpn",
                "variant": "tcp"
            },
            "settings": {
                "endpoint": {
                    "hosts": [
                        "vpn.example.com"
                    ],
                    "ports": [
                        1194
                    ]
                },
                "profile": "client\ndev tun\nauth-user-pass\nremote-cert-tls server\n",
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "OpenVPN TCP",
            "tunnels": {
                "openvpn": {
                    "variants": [
                        "tcp"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
OpenVPN UDP Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "OpenVPN",
    "tunnel": {
        "family": "openvpn",
        "variant": "udp"
    },
    "settings": {
        "endpoint": {
            "hosts": [
                "vpn.example.com"
            ],
            "ports": [
                1194
            ]
        },
        "profile": "client\ndev tun\nauth-user-pass\nremote-cert-tls server\n",
        "credentials": {
            "username": "demo",
            "password": "secret"
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        []
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "OpenVPN UDP",
    "tunnels": {
        "openvpn": {
            "variants": [
                "udp"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "OpenVPN UDP",
    "servers": [
        {
            "name": "OpenVPN",
            "tunnel": {
                "family": "openvpn",
                "variant": "udp"
            },
            "settings": {
                "endpoint": {
                    "hosts": [
                        "vpn.example.com"
                    ],
                    "ports": [
                        1194
                    ]
                },
                "profile": "client\ndev tun\nauth-user-pass\nremote-cert-tls server\n",
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                []
            ]
        }
    ],
    "tweaks": [
        {
            "name": "OpenVPN UDP",
            "tunnels": {
                "openvpn": {
                    "variants": [
                        "udp"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
OpenVPN TCP / UDP Shared tweak

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "OpenVPN TCP / UDP",
    "tunnels": {
        "openvpn": {
            "variants": [
                "tcp",
                "udp"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "OpenVPN TCP / UDP",
    "servers": [],
    "tweaks": [
        {
            "name": "OpenVPN TCP / UDP",
            "tunnels": {
                "openvpn": {
                    "variants": [
                        "tcp",
                        "udp"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
OpenVPN / SSH Shared tweak

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "OpenVPN / SSH",
    "tunnels": {
        "openvpn": {
            "variants": [
                "tcp"
            ]
        },
        "ssh": {
            "variants": [
                "default"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        },
        "proxy": {
            "hosts": [
                "proxy.example.com"
            ],
            "ports": [
                443,
                444
            ]
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "OpenVPN / SSH",
    "servers": [],
    "tweaks": [
        {
            "name": "OpenVPN / SSH",
            "tunnels": {
                "openvpn": {
                    "variants": [
                        "tcp"
                    ]
                },
                "ssh": {
                    "variants": [
                        "default"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                },
                "proxy": {
                    "hosts": [
                        "proxy.example.com"
                    ],
                    "ports": [
                        443,
                        444
                    ]
                }
            }
        }
    ]
}
SSH Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "SSH",
    "tunnel": {
        "family": "ssh",
        "variant": "default"
    },
    "settings": {
        "endpoint": {
            "hosts": [
                "ssh1.example.com",
                "ssh2.example.com"
            ],
            "ports": [
                22,
                2222
            ]
        },
        "credentials": {
            "username": "demo",
            "password": "secret"
        },
        "tls_ports": [
            443,
            8443
        ]
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "SSH",
    "tunnels": {
        "ssh": {
            "variants": [
                "default"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "SSH",
    "servers": [
        {
            "name": "SSH",
            "tunnel": {
                "family": "ssh",
                "variant": "default"
            },
            "settings": {
                "endpoint": {
                    "hosts": [
                        "ssh1.example.com",
                        "ssh2.example.com"
                    ],
                    "ports": [
                        22,
                        2222
                    ]
                },
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                },
                "tls_ports": [
                    443,
                    8443
                ]
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "SSH",
            "tunnels": {
                "ssh": {
                    "variants": [
                        "default"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                }
            }
        }
    ]
}
SSH BHTTP Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "BHTTP",
    "tunnel": {
        "family": "ssh",
        "variant": "bhttp"
    },
    "settings": {
        "endpoint": {
            "hosts": [
                "relay.example.com"
            ],
            "ports": [
                8081
            ]
        },
        "credentials": {
            "username": "demo",
            "password": "secret"
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        []
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "SSH BHTTP",
    "tunnels": {
        "ssh": {
            "variants": [
                "bhttp"
            ],
            "bhttp": {
                "version": 2,
                "chunk_size": 1399,
                "download_batch": 8,
                "upload_workers": 32,
                "download_workers": 16
            }
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "SSH BHTTP",
    "servers": [
        {
            "name": "BHTTP",
            "tunnel": {
                "family": "ssh",
                "variant": "bhttp"
            },
            "settings": {
                "endpoint": {
                    "hosts": [
                        "relay.example.com"
                    ],
                    "ports": [
                        8081
                    ]
                },
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                []
            ]
        }
    ],
    "tweaks": [
        {
            "name": "SSH BHTTP",
            "tunnels": {
                "ssh": {
                    "variants": [
                        "bhttp"
                    ],
                    "bhttp": {
                        "version": 2,
                        "chunk_size": 1399,
                        "download_batch": 8,
                        "upload_workers": 32,
                        "download_workers": 16
                    }
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
SSH HCR Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "HCR",
    "tunnel": {
        "family": "ssh",
        "variant": "hcr"
    },
    "settings": {
        "endpoint": {
            "hosts": [
                "relay.example.com"
            ],
            "ports": [
                8081
            ]
        },
        "credentials": {
            "username": "demo",
            "password": "secret"
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        []
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "SSH HCR",
    "tunnels": {
        "ssh": {
            "variants": [
                "hcr"
            ],
            "hcr": {
                "mode": "hcr_v1"
            }
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "SSH HCR",
    "servers": [
        {
            "name": "HCR",
            "tunnel": {
                "family": "ssh",
                "variant": "hcr"
            },
            "settings": {
                "endpoint": {
                    "hosts": [
                        "relay.example.com"
                    ],
                    "ports": [
                        8081
                    ]
                },
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                []
            ]
        }
    ],
    "tweaks": [
        {
            "name": "SSH HCR",
            "tunnels": {
                "ssh": {
                    "variants": [
                        "hcr"
                    ],
                    "hcr": {
                        "mode": "hcr_v1"
                    }
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
SSH SlowDNS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "SSH SlowDNS",
    "tunnel": {
        "family": "ssh",
        "variant": "default"
    },
    "settings": {
        "credentials": {
            "username": "demo",
            "password": "secret"
        }
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "nameservers": [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "public_key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        }
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "SSH SlowDNS",
    "tunnels": {
        "ssh": {
            "variants": [
                "default"
            ]
        }
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "resolvers": [
                "https://dns.google/dns-query"
            ],
            "kcp_window": 512
        }
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "SSH SlowDNS",
    "servers": [
        {
            "name": "SSH SlowDNS",
            "tunnel": {
                "family": "ssh",
                "variant": "default"
            },
            "settings": {
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                }
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "nameservers": [
                        "ns1.example.com",
                        "ns2.example.com"
                    ],
                    "public_key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                }
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "SSH SlowDNS",
            "tunnels": {
                "ssh": {
                    "variants": [
                        "default"
                    ]
                }
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "resolvers": [
                        "https://dns.google/dns-query"
                    ],
                    "kcp_window": 512
                }
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                }
            }
        }
    ]
}
OpenVPN SlowDNS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "OpenVPN SlowDNS",
    "tunnel": {
        "family": "openvpn",
        "variant": "tcp"
    },
    "settings": {
        "profile": "client\ndev tun\nauth-user-pass\nremote-cert-tls server\n",
        "credentials": {
            "username": "demo",
            "password": "secret"
        }
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "nameservers": [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "public_key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        }
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "OpenVPN SlowDNS",
    "tunnels": {
        "openvpn": {
            "variants": [
                "tcp"
            ]
        }
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "resolvers": [
                "https://dns.google/dns-query"
            ],
            "kcp_window": 512
        }
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "OpenVPN SlowDNS",
    "servers": [
        {
            "name": "OpenVPN SlowDNS",
            "tunnel": {
                "family": "openvpn",
                "variant": "tcp"
            },
            "settings": {
                "profile": "client\ndev tun\nauth-user-pass\nremote-cert-tls server\n",
                "credentials": {
                    "username": "demo",
                    "password": "secret"
                }
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "nameservers": [
                        "ns1.example.com",
                        "ns2.example.com"
                    ],
                    "public_key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                }
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "OpenVPN SlowDNS",
            "tunnels": {
                "openvpn": {
                    "variants": [
                        "tcp"
                    ]
                }
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "resolvers": [
                        "https://dns.google/dns-query"
                    ],
                    "kcp_window": 512
                }
            },
            "methods": {}
        }
    ]
}
OpenVPN / SSH SlowDNS Shared tweak

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "OpenVPN / SSH SlowDNS",
    "tunnels": {
        "openvpn": {
            "variants": [
                "tcp"
            ]
        },
        "ssh": {
            "variants": [
                "default"
            ]
        }
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "resolvers": [
                "https://dns.google/dns-query"
            ],
            "kcp_window": 512
        }
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "OpenVPN / SSH SlowDNS",
    "servers": [],
    "tweaks": [
        {
            "name": "OpenVPN / SSH SlowDNS",
            "tunnels": {
                "openvpn": {
                    "variants": [
                        "tcp"
                    ]
                },
                "ssh": {
                    "variants": [
                        "default"
                    ]
                }
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "resolvers": [
                        "https://dns.google/dns-query"
                    ],
                    "kcp_window": 512
                }
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                }
            }
        }
    ]
}
UDP Hysteria Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "UDP Hysteria",
    "tunnel": {
        "family": "hysteria",
        "variant": "default"
    },
    "settings": {
        "endpoint": {
            "hosts": [
                "hy.example.com",
                "2001:db8::10",
                "2001:db8::11"
            ],
            "port_sets": [
                [
                    {
                        "from": 443,
                        "to": 443
                    },
                    {
                        "from": 500,
                        "to": 3445
                    }
                ],
                [
                    {
                        "from": 3000,
                        "to": 4000
                    },
                    {
                        "from": 4500,
                        "to": 5000
                    }
                ],
                [
                    {
                        "from": 5670,
                        "to": 5670
                    }
                ]
            ]
        },
        "authentication": "auth-token",
        "obfuscation_password": "obfs-password",
        "bandwidth": {
            "upload_mbps": 20,
            "download_mbps": 50
        },
        "alpn": "h3",
        "hop_interval_seconds": 10
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "tls"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "UDP Hysteria",
    "tunnels": {
        "hysteria": {
            "variants": [
                "default"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {
        "tls": {
            "sni": [
                "hy.example.com"
            ]
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "UDP Hysteria",
    "servers": [
        {
            "name": "UDP Hysteria",
            "tunnel": {
                "family": "hysteria",
                "variant": "default"
            },
            "settings": {
                "endpoint": {
                    "hosts": [
                        "hy.example.com",
                        "2001:db8::10",
                        "2001:db8::11"
                    ],
                    "port_sets": [
                        [
                            {
                                "from": 443,
                                "to": 443
                            },
                            {
                                "from": 500,
                                "to": 3445
                            }
                        ],
                        [
                            {
                                "from": 3000,
                                "to": 4000
                            },
                            {
                                "from": 4500,
                                "to": 5000
                            }
                        ],
                        [
                            {
                                "from": 5670,
                                "to": 5670
                            }
                        ]
                    ]
                },
                "authentication": "auth-token",
                "obfuscation_password": "obfs-password",
                "bandwidth": {
                    "upload_mbps": 20,
                    "download_mbps": 50
                },
                "alpn": "h3",
                "hop_interval_seconds": 10
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "tls"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "UDP Hysteria",
            "tunnels": {
                "hysteria": {
                    "variants": [
                        "default"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {
                "tls": {
                    "sni": [
                        "hy.example.com"
                    ]
                }
            }
        }
    ]
}
V2Ray VLESS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "vless"
    },
    "settings": {
        "profile": "vless://[email protected]:443?type=tcp&security=tls"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray VLESS",
    "tunnels": {
        "v2ray": {
            "variants": [
                "vless"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray VLESS",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "vless"
            },
            "settings": {
                "profile": "vless://[email protected]:443?type=tcp&security=tls"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray VLESS",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "vless"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray VMESS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "vmess"
    },
    "settings": {
        "profile": "vmess://eyJ2IjoiMiIsImFkZCI6InZtZXNzLmV4YW1wbGUuY29tIiwicG9ydCI6IjQ0MyIsImlkIjoiMTExMTExMTEtMTExMS00MTExLTgxMTEtMTExMTExMTExMTExIiwiYWlkIjoiMCIsIm5ldCI6InRjcCIsInRscyI6InRscyJ9"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray VMESS",
    "tunnels": {
        "v2ray": {
            "variants": [
                "vmess"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray VMESS",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "vmess"
            },
            "settings": {
                "profile": "vmess://eyJ2IjoiMiIsImFkZCI6InZtZXNzLmV4YW1wbGUuY29tIiwicG9ydCI6IjQ0MyIsImlkIjoiMTExMTExMTEtMTExMS00MTExLTgxMTEtMTExMTExMTExMTExIiwiYWlkIjoiMCIsIm5ldCI6InRjcCIsInRscyI6InRscyJ9"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray VMESS",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "vmess"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray HYSTERIA2 Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "hysteria2"
    },
    "settings": {
        "profile": "hysteria2://[email protected]:443"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        []
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray HYSTERIA2",
    "tunnels": {
        "v2ray": {
            "variants": [
                "hysteria2"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray HYSTERIA2",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "hysteria2"
            },
            "settings": {
                "profile": "hysteria2://[email protected]:443"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                []
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray HYSTERIA2",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "hysteria2"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray SOCKS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "socks"
    },
    "settings": {
        "profile": "socks://demo:[email protected]:1080"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray SOCKS",
    "tunnels": {
        "v2ray": {
            "variants": [
                "socks"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray SOCKS",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "socks"
            },
            "settings": {
                "profile": "socks://demo:[email protected]:1080"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray SOCKS",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "socks"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray HTTP Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "http"
    },
    "settings": {
        "profile": "http://demo:[email protected]:8080"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray HTTP",
    "tunnels": {
        "v2ray": {
            "variants": [
                "http"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray HTTP",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "http"
            },
            "settings": {
                "profile": "http://demo:[email protected]:8080"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray HTTP",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "http"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray SS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "ss"
    },
    "settings": {
        "profile": "ss://[email protected]:8388"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray SS",
    "tunnels": {
        "v2ray": {
            "variants": [
                "ss"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray SS",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "ss"
            },
            "settings": {
                "profile": "ss://[email protected]:8388"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray SS",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "ss"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray TROJAN Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "trojan"
    },
    "settings": {
        "profile": "trojan://[email protected]:443?type=tcp&security=tls"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray TROJAN",
    "tunnels": {
        "v2ray": {
            "variants": [
                "trojan"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray TROJAN",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "trojan"
            },
            "settings": {
                "profile": "trojan://[email protected]:443?type=tcp&security=tls"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray TROJAN",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "trojan"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray WIREGUARD Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray",
    "tunnel": {
        "family": "v2ray",
        "variant": "wireguard"
    },
    "settings": {
        "profile": "[Interface]\nPrivateKey = YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWE=\nAddress = 10.0.0.2/32\n\n[Peer]\nPublicKey = YmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmI=\nEndpoint = wg.example.com:51820"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        []
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray WIREGUARD",
    "tunnels": {
        "v2ray": {
            "variants": [
                "wireguard"
            ],
            "bug_hosts": [
                "edge.example.com"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray WIREGUARD",
    "servers": [
        {
            "name": "V2Ray",
            "tunnel": {
                "family": "v2ray",
                "variant": "wireguard"
            },
            "settings": {
                "profile": "[Interface]\nPrivateKey = YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWE=\nAddress = 10.0.0.2/32\n\n[Peer]\nPublicKey = YmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmI=\nEndpoint = wg.example.com:51820"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                []
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray WIREGUARD",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "wireguard"
                    ],
                    "bug_hosts": [
                        "edge.example.com"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {}
        }
    ]
}
V2Ray VLESS + Payload Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray RAW/TCP",
    "tunnel": {
        "family": "v2ray",
        "variant": "vless"
    },
    "settings": {
        "profile": "vless://[email protected]:443?type=tcp&security=tls"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray VLESS + Payload",
    "tunnels": {
        "v2ray": {
            "variants": [
                "vless"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        },
        "proxy": {
            "hosts": [
                "proxy.example.com"
            ],
            "ports": [
                443,
                444
            ]
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray VLESS + Payload",
    "servers": [
        {
            "name": "V2Ray RAW/TCP",
            "tunnel": {
                "family": "v2ray",
                "variant": "vless"
            },
            "settings": {
                "profile": "vless://[email protected]:443?type=tcp&security=tls"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray VLESS + Payload",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "vless"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                },
                "proxy": {
                    "hosts": [
                        "proxy.example.com"
                    ],
                    "ports": [
                        443,
                        444
                    ]
                }
            }
        }
    ]
}
V2Ray VMESS + Payload Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray RAW/TCP",
    "tunnel": {
        "family": "v2ray",
        "variant": "vmess"
    },
    "settings": {
        "profile": "vmess://eyJ2IjoiMiIsImFkZCI6InZtZXNzLmV4YW1wbGUuY29tIiwicG9ydCI6IjQ0MyIsImlkIjoiMTExMTExMTEtMTExMS00MTExLTgxMTEtMTExMTExMTExMTExIiwiYWlkIjoiMCIsIm5ldCI6InRjcCIsInRscyI6InRscyJ9"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray VMESS + Payload",
    "tunnels": {
        "v2ray": {
            "variants": [
                "vmess"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        },
        "proxy": {
            "hosts": [
                "proxy.example.com"
            ],
            "ports": [
                443,
                444
            ]
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray VMESS + Payload",
    "servers": [
        {
            "name": "V2Ray RAW/TCP",
            "tunnel": {
                "family": "v2ray",
                "variant": "vmess"
            },
            "settings": {
                "profile": "vmess://eyJ2IjoiMiIsImFkZCI6InZtZXNzLmV4YW1wbGUuY29tIiwicG9ydCI6IjQ0MyIsImlkIjoiMTExMTExMTEtMTExMS00MTExLTgxMTEtMTExMTExMTExMTExIiwiYWlkIjoiMCIsIm5ldCI6InRjcCIsInRscyI6InRscyJ9"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray VMESS + Payload",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "vmess"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                },
                "proxy": {
                    "hosts": [
                        "proxy.example.com"
                    ],
                    "ports": [
                        443,
                        444
                    ]
                }
            }
        }
    ]
}
V2Ray TROJAN + Payload Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray RAW/TCP",
    "tunnel": {
        "family": "v2ray",
        "variant": "trojan"
    },
    "settings": {
        "profile": "trojan://[email protected]:443?type=tcp&security=tls"
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "proxy"
        ],
        [
            "payload",
            "proxy"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ],
        [
            "tls",
            "proxy"
        ],
        [
            "payload",
            "tls",
            "proxy"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray TROJAN + Payload",
    "tunnels": {
        "v2ray": {
            "variants": [
                "trojan"
            ]
        }
    },
    "carrier": {
        "type": "default",
        "settings": {}
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        },
        "proxy": {
            "hosts": [
                "proxy.example.com"
            ],
            "ports": [
                443,
                444
            ]
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray TROJAN + Payload",
    "servers": [
        {
            "name": "V2Ray RAW/TCP",
            "tunnel": {
                "family": "v2ray",
                "variant": "trojan"
            },
            "settings": {
                "profile": "trojan://[email protected]:443?type=tcp&security=tls"
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "proxy"
                ],
                [
                    "payload",
                    "proxy"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ],
                [
                    "tls",
                    "proxy"
                ],
                [
                    "payload",
                    "tls",
                    "proxy"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray TROJAN + Payload",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "trojan"
                    ]
                }
            },
            "carrier": {
                "type": "default",
                "settings": {}
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                },
                "proxy": {
                    "hosts": [
                        "proxy.example.com"
                    ],
                    "ports": [
                        443,
                        444
                    ]
                }
            }
        }
    ]
}
V2Ray SlowDNS Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "V2Ray SlowDNS",
    "tunnel": {
        "family": "v2ray",
        "variant": "vless"
    },
    "settings": {
        "profile": "vless://[email protected]:443?type=tcp&security=tls"
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "nameservers": [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "public_key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        }
    },
    "accepted_methods": [
        [],
        [
            "payload"
        ],
        [
            "tls"
        ],
        [
            "payload",
            "tls"
        ]
    ]
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "V2Ray SlowDNS",
    "tunnels": {
        "v2ray": {
            "variants": [
                "vless"
            ]
        }
    },
    "carrier": {
        "type": "slowdns",
        "settings": {
            "resolvers": [
                "https://dns.google/dns-query"
            ],
            "kcp_window": 512
        }
    },
    "methods": {
        "payload": {
            "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
        },
        "tls": {
            "sni": [
                "edge.example.com"
            ],
            "version": "TLSv1.2"
        }
    }
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "V2Ray SlowDNS",
    "servers": [
        {
            "name": "V2Ray SlowDNS",
            "tunnel": {
                "family": "v2ray",
                "variant": "vless"
            },
            "settings": {
                "profile": "vless://[email protected]:443?type=tcp&security=tls"
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "nameservers": [
                        "ns1.example.com",
                        "ns2.example.com"
                    ],
                    "public_key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                }
            },
            "accepted_methods": [
                [],
                [
                    "payload"
                ],
                [
                    "tls"
                ],
                [
                    "payload",
                    "tls"
                ]
            ]
        }
    ],
    "tweaks": [
        {
            "name": "V2Ray SlowDNS",
            "tunnels": {
                "v2ray": {
                    "variants": [
                        "vless"
                    ]
                }
            },
            "carrier": {
                "type": "slowdns",
                "settings": {
                    "resolvers": [
                        "https://dns.google/dns-query"
                    ],
                    "kcp_window": 512
                }
            },
            "methods": {
                "payload": {
                    "value": "GET / HTTP/1.1[crlf]Host: edge.example.com[crlf][crlf]"
                },
                "tls": {
                    "sni": [
                        "edge.example.com"
                    ],
                    "version": "TLSv1.2"
                }
            }
        }
    ]
}
SSH Slipstream Server + tweak

Server

POST /api/v1/configs/{config_key}/servers

{
    "name": "SSH over Slipstream",
    "tunnel": {
        "family": "ssh",
        "variant": "default"
    },
    "carrier": {
        "type": "slipstream",
        "settings": {
            "domains": [
                "tunnel.example.com"
            ]
        }
    },
    "accepted_methods": [
        []
    ],
    "settings": {
        "credentials": {
            "username": "demo",
            "password": "replace-me"
        }
    }
}

Tweak

POST /api/v1/configs/{config_key}/tweaks

{
    "name": "Slipstream",
    "tunnels": {
        "ssh": {
            "variants": [
                "default"
            ]
        }
    },
    "carrier": {
        "type": "slipstream",
        "settings": {
            "resolvers": [
                "1.1.1.1:53"
            ],
            "keep_alive_ms": 400,
            "congestion_control": "bbr"
        }
    },
    "methods": {}
}

Configuration

POST /api/business/v1/config/generate

{
    "name": "SSH Slipstream",
    "servers": [
        {
            "name": "SSH over Slipstream",
            "tunnel": {
                "family": "ssh",
                "variant": "default"
            },
            "carrier": {
                "type": "slipstream",
                "settings": {
                    "domains": [
                        "tunnel.example.com"
                    ]
                }
            },
            "accepted_methods": [
                []
            ],
            "settings": {
                "credentials": {
                    "username": "demo",
                    "password": "replace-me"
                }
            }
        }
    ],
    "tweaks": [
        {
            "name": "Slipstream",
            "tunnels": {
                "ssh": {
                    "variants": [
                        "default"
                    ]
                }
            },
            "carrier": {
                "type": "slipstream",
                "settings": {
                    "resolvers": [
                        "1.1.1.1:53"
                    ],
                    "keep_alive_ms": 400,
                    "congestion_control": "bbr"
                }
            },
            "methods": {}
        }
    ]
}
HTTP Tweak developer documentation Current API contract