3X-UI API collection
\nPurpose & Scope
\nGetting Started
\nAuth
\nEnvironment Variables
\nRunning Tests and Monitors
\nNotes
\nPurpose: Authenticate a user and create a session/token.
\nPath: /login/\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Usually no auth; returns auth cookie/token on success.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/login/\"
-H \"Content-Type: application/json\"
-d '{\"username\":\"\",\"password\":\"\"}'
Success: 200 OK (login successful)\nErrors: 400/422 (validation), 401 (invalid creds), 429, 500.\nIdempotency: Not idempotent (may create new session). Side effects: starts an authenticated session and may set cookies.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["login",""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"55b8d926-0ab6-4c73-a972-16a274d19b5c","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","type":"text","uuid":"d4c70460-81c2-46d9-9477-9e666f36c2b5"},{"key":"password","value":"","type":"text","uuid":"1108e54b-a2f9-4c7c-9f5a-d1b08f47ba43"},{"key":"twoFactorCode","value":"","type":"text","uuid":"43cadfc8-52c1-427e-92a2-5d6fbfc8d549"}]},"url":"http://localhost:2053/randompath/login/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Set-Cookie","value":"3x-ui=MTc1ODgwMDA0OHxEWDhFQVFMX2dBQUJFQUVRQUFCOV80QUFBUVp6ZEhKcGJtY01EQUFLVEU5SFNVNWZWVk5GVWpCbmFYUm9kV0l1WTI5dEwyMW9jMkZ1WVdWcEx6TjRMWFZwTDNZeUwyUmhkR0ZpWVhObEwyMXZaR1ZzTGxWelpYTF9nUU1CQVFSVmMyVnlBZi1DQUFFREFRSkpaQUVFQUFFSVZYTmxjbTVoYldVQkRBQUJDRkJoYzNOM2IzSmtBUXdBQUFCTF80SklBUUlCQldGa2JXbHVBVHdrTW1Fa01UQWtTa05VVlRKWVZGRlllbTQyTnk5cFFUSnpOVWx0VDBKT2IySlhSMWN3WVVWUFZHSkJUbk4xWlhwRGJYWm5RM2d6TW5SblIwY0F8YWaXytYmy5DT_IZkX_xRb8tq4RTo_z_wy-L7kmoBjlc=; Path=/; Expires=Thu, 25 Sep 2025 17:34:08 GMT; Max-Age=21600; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 25 Sep 2025 11:34:08 GMT"},{"key":"Content-Length","value":"100"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \" You have successfully logged into your account.\",\n \"obj\": null\n}"},{"id":"c7c6cee0-9e95-4a58-9b06-ab6d3935a915","name":"failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","type":"text","uuid":"d4c70460-81c2-46d9-9477-9e666f36c2b5"},{"key":"password","value":"","type":"text","uuid":"1108e54b-a2f9-4c7c-9f5a-d1b08f47ba43"},{"key":"twoFactorCode","value":"","type":"text","uuid":"43cadfc8-52c1-427e-92a2-5d6fbfc8d549"}]},"url":"http://localhost:2053/randompath/login/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 25 Sep 2025 11:34:49 GMT"},{"key":"Content-Length","value":"103"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Invalid username or password or two-factor code.\",\n \"obj\": null\n}"}],"_postman_id":"e19c588a-1378-42bf-a925-29852d779351"},{"name":"Inbounds","id":"d3dd1629-ea3e-4c9f-ba5c-cc9200b26461","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/list","description":"Purpose: List all inbounds visible to the current user.
\nPath: /panel/api/inbounds/list\nQuery: optional filters may be supported by server (not specified).
\nParams: none.
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires prior login/session or token.
\nExample:\ncurl \"http://localhost:2053/randompath/panel/api/inbounds/list\" -H \"Cookie: \"
\nSuccess: 200 OK (array of inbounds)\nErrors: 401 (unauthorized), 403 (forbidden), 429, 500.\nIdempotency: Safe and idempotent (read-only).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","list"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"1800c3fc-07ec-4b26-a14b-6a790e03f676","name":"success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 23 Sep 2025 09:51:10 GMT"},{"key":"Content-Length","value":"1981"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\n {\n \"id\": 1,\n \"up\": 0,\n \"down\": 0,\n \"total\": 0,\n \"allTime\": 0,\n \"remark\": \"\",\n \"enable\": true,\n \"expiryTime\": 0,\n \"trafficReset\": \"never\",\n \"lastTrafficResetTime\": 0,\n \"clientStats\": [\n {\n \"id\": 1,\n \"inboundId\": 1,\n \"enable\": false,\n \"email\": \"aadsykn0\",\n \"uuid\": \"1c6079e6-5342-47fa-a9f0-1188bf4e2ef6\",\n \"subId\": \"dff4pajow34ymeiv\",\n \"up\": 0,\n \"down\": 0,\n \"allTime\": 0,\n \"expiryTime\": 0,\n \"total\": 0,\n \"reset\": 0,\n \"lastOnline\": 0\n },\n {\n \"id\": 2,\n \"inboundId\": 1,\n \"enable\": true,\n \"email\": \"cle5b4n7\",\n \"uuid\": \"c29c95e2-9c76-44c3-ba3d-ad57eba215b0\",\n \"subId\": \"zx95rirylinj93e4\",\n \"up\": 0,\n \"down\": 0,\n \"allTime\": 0,\n \"expiryTime\": 0,\n \"total\": 0,\n \"reset\": 0,\n \"lastOnline\": 0\n }\n ],\n \"listen\": \"\",\n \"port\": 30886,\n \"protocol\": \"vless\",\n \"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"comment\\\": \\\"\\\",\\n \\\"created_at\\\": 1758532912000,\\n \\\"email\\\": \\\"aadsykn0\\\",\\n \\\"enable\\\": false,\\n \\\"expiryTime\\\": 0,\\n \\\"flow\\\": \\\"\\\",\\n \\\"id\\\": \\\"1c6079e6-5342-47fa-a9f0-1188bf4e2ef6\\\",\\n \\\"limitIp\\\": 0,\\n \\\"reset\\\": 0,\\n \\\"subId\\\": \\\"dff4pajow34ymeiv\\\",\\n \\\"tgId\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"updated_at\\\": 1758620508000\\n },\\n {\\n \\\"comment\\\": \\\"\\\",\\n \\\"created_at\\\": 1758620950000,\\n \\\"email\\\": \\\"cle5b4n7\\\",\\n \\\"enable\\\": true,\\n \\\"expiryTime\\\": 0,\\n \\\"flow\\\": \\\"\\\",\\n \\\"id\\\": \\\"c29c95e2-9c76-44c3-ba3d-ad57eba215b0\\\",\\n \\\"limitIp\\\": 0,\\n \\\"reset\\\": 0,\\n \\\"subId\\\": \\\"zx95rirylinj93e4\\\",\\n \\\"tgId\\\": \\\"\\\",\\n \\\"totalGB\\\": 0,\\n \\\"updated_at\\\": 1758620950000\\n }\\n ],\\n \\\"decryption\\\": \\\"none\\\",\\n \\\"encryption\\\": \\\"none\\\"\\n}\",\n \"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\n \"tag\": \"inbound-30886\",\n \"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\"\n }\n ]\n}"},{"id":"d4620c0c-23e0-4bfe-817d-b842119e7674","name":"No Inbounds","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 13:46:23 GMT"},{"key":"Content-Length","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": []\n}"}],"_postman_id":"d3dd1629-ea3e-4c9f-ba5c-cc9200b26461"},{"name":"Inbound","id":"e2739935-ac1a-4697-a1a3-062442a7ceef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/get/{inboundId}","description":"Purpose: Get details of a specific inbound by ID.
\nPath: /panel/api/inbounds/get/{inboundId}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated session/token.
\nExample:\ncurl \"http://localhost:2053/randompath/panel/api/inbounds/get/{inboundId}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400 (bad id), 401, 404 (not found), 429, 500.\nIdempotency: Safe and idempotent (read-only).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","get","{inboundId}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ecb8833e-63fe-4577-808a-0f2799e97559","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/get/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 23 Sep 2025 09:51:29 GMT"},{"key":"Content-Length","value":"1567"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"id\": 1,\n \"up\": 0,\n \"down\": 0,\n \"total\": 0,\n \"allTime\": 0,\n \"remark\": \"\",\n \"enable\": true,\n \"expiryTime\": 0,\n \"trafficReset\": \"never\",\n \"lastTrafficResetTime\": 0,\n \"clientStats\": null,\n \"listen\": \"\",\n \"port\": 30886,\n \"protocol\": \"vless\",\n \"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"comment\\\": \\\"\\\",\\n \\\"created_at\\\": 1758532912000,\\n \\\"email\\\": \\\"aadsykn0\\\",\\n \\\"enable\\\": false,\\n \\\"expiryTime\\\": 0,\\n \\\"flow\\\": \\\"\\\",\\n \\\"id\\\": \\\"1c6079e6-5342-47fa-a9f0-1188bf4e2ef6\\\",\\n \\\"limitIp\\\": 0,\\n \\\"reset\\\": 0,\\n \\\"subId\\\": \\\"dff4pajow34ymeiv\\\",\\n \\\"tgId\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"updated_at\\\": 1758620508000\\n },\\n {\\n \\\"comment\\\": \\\"\\\",\\n \\\"created_at\\\": 1758620950000,\\n \\\"email\\\": \\\"cle5b4n7\\\",\\n \\\"enable\\\": true,\\n \\\"expiryTime\\\": 0,\\n \\\"flow\\\": \\\"\\\",\\n \\\"id\\\": \\\"c29c95e2-9c76-44c3-ba3d-ad57eba215b0\\\",\\n \\\"limitIp\\\": 0,\\n \\\"reset\\\": 0,\\n \\\"subId\\\": \\\"zx95rirylinj93e4\\\",\\n \\\"tgId\\\": \\\"\\\",\\n \\\"totalGB\\\": 0,\\n \\\"updated_at\\\": 1758620950000\\n }\\n ],\\n \\\"decryption\\\": \\\"none\\\",\\n \\\"encryption\\\": \\\"none\\\"\\n}\",\n \"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\n \"tag\": \"inbound-30886\",\n \"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\"\n }\n}"},{"id":"7b0c9a26-904a-4006-b284-969898d763fa","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/get/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 13:45:50 GMT"},{"key":"Content-Length","value":"90"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Obtain Failed: record not found\",\n \"obj\": null\n}"}],"_postman_id":"e2739935-ac1a-4697-a1a3-062442a7ceef"},{"name":"Client Traffics with email","id":"15870a79-5479-4155-9806-965c597ef327","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/getClientTraffics/{email}","description":"Purpose: Fetch client traffic usage by email.
\nPath: /panel/api/inbounds/getClientTraffics/{email}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated session/token.
\nExample:\ncurl \"http://localhost:2053/randompath/panel/api/inbounds/getClientTraffics/{email}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400 (invalid email), 401, 404, 429, 500.\nIdempotency: Safe and idempotent (read-only).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","getClientTraffics","{email}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3e2665e8-dad3-441c-9540-892b85a7d546","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/getClientTraffics/cycd2pj6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 21 Sep 2025 20:21:07 GMT"},{"key":"Content-Length","value":"238"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"id\": 1,\n \"inboundId\": 1,\n \"enable\": true,\n \"email\": \"cycd2pj6\",\n \"uuid\": \"113e88fd-749a-48af-a358-e642b581e6cb\",\n \"subId\": \"5fm4zt28zq31pf1v\",\n \"up\": 0,\n \"down\": 0,\n \"allTime\": 0,\n \"expiryTime\": 0,\n \"total\": 0,\n \"reset\": 0,\n \"lastOnline\": 0\n }\n}"},{"id":"7d74e41f-ac77-449d-8578-9904e9d7204a","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/getClientTraffics/s729v2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 13:49:06 GMT"},{"key":"Content-Length","value":"60"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": null\n}"}],"_postman_id":"15870a79-5479-4155-9806-965c597ef327"},{"name":"Client Traffics with ID","id":"758fe7b5-8023-4267-a554-9b1d58ad45e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/getClientTrafficsById/{uuid}","description":"Purpose: Fetch client traffic usage by client UUID.
\nPath: /panel/api/inbounds/getClientTrafficsById/{uuid}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated session/token.
\nExample:\ncurl \"http://localhost:2053/randompath/panel/api/inbounds/getClientTrafficsById/{uuid}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400 (invalid UUID), 401, 404, 429, 500.\nIdempotency: Safe (read-only).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","getClientTrafficsById","{uuid}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"dfcfef07-f038-4d3b-8dae-bc48c86e6079","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/getClientTrafficsById/411d895d-5d18-4524-b507-2a186039d6cb"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 16 Sep 2025 12:48:42 GMT"},{"key":"Content-Length","value":"170"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\n {\n \"id\": 26,\n \"inboundId\": 24,\n \"enable\": false,\n \"email\": \"r8zrgmdu\",\n \"up\": 0,\n \"down\": 0,\n \"allTime\": 0,\n \"expiryTime\": 0,\n \"total\": 0,\n \"reset\": 0,\n \"lastOnline\": 0\n }\n ]\n}"},{"id":"58232bdb-da20-47db-a828-761dd1fbcdb4","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/getClientTrafficsById/a39c9655-bcbb-43c4-9b3b-ebd8b7ae9111"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 13:51:10 GMT"},{"key":"Content-Length","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": []\n}"}],"_postman_id":"758fe7b5-8023-4267-a554-9b1d58ad45e9"},{"name":"tgbot - sends backup to admins","id":"4ff6440c-53af-4846-9934-144ecd5029ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"","value":"","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/backuptotgbot","description":"Purpose: Trigger sending a backup to Telegram bot admins.
\nPath: /panel/api/backuptotgbot\nQuery: none
\nParams: none.
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires admin session/token.
\nExample:\ncurl \"http://localhost:2053/randompath/panel/api/backuptotgbot\" -H \"Cookie: \"
\nSuccess: 200 OK (trigger accepted)\nErrors: 401/403, 429, 500.\nIdempotency: Not guaranteed; repeated calls may send multiple backups. Side effects: Initiates backup send.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","backuptotgbot"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ff6440c-53af-4846-9934-144ecd5029ef"},{"name":"Client Ip address","id":"843db4c1-a844-4d1f-85db-e7afc7330c5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/clientIps/{email}","description":"Purpose: Retrieve client IP address history by email.
\nPath: /panel/api/inbounds/clientIps/{email}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/clientIps/{email}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400 (invalid email), 401, 404, 429, 500.\nIdempotency: Read-like but uses POST; no side effects expected.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","clientIps","{email}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"be8fcb22-1706-41de-a55f-107f948bcb83","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/clientIps/s729v2km"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 23:37:10 GMT"},{"key":"Content-Length","value":"46"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": \"No IP Record\"\n}"}],"_postman_id":"843db4c1-a844-4d1f-85db-e7afc7330c5c"},{"name":"Add Inbound","id":"1315bbf2-f8e2-4c35-bf50-adf10cd8c752","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"up\": 0,\r\n\"down\": 0,\r\n\"total\": 0,\r\n\"remark\": \"New\",\r\n\"enable\": true,\r\n\"expiryTime\": 0,\r\n\"listen\": \"\",\r\n\"port\": 55421,\r\n\"protocol\": \"vless\",\r\n\"settings\": \"{\\\"clients\\\": [{\\\"id\\\": \\\"b86c0cdc-8a02-4da4-8693-72ba27005587\\\",\\\"flow\\\": \\\"\\\",\\\"email\\\": \\\"nt3wz904\\\",\\\"limitIp\\\": 0,\\\"totalGB\\\": 0,\\\"expiryTime\\\": 0,\\\"enable\\\": true,\\\"tgId\\\": \\\"\\\",\\\"subId\\\": \\\"rqv5zw1ydutamcp0\\\",\\\"reset\\\": 0}],\\\"decryption\\\": \\\"none\\\",\\\"fallbacks\\\": []}\",\r\n\"streamSettings\": \"{\\\"network\\\": \\\"tcp\\\",\\\"security\\\": \\\"reality\\\",\\\"externalProxy\\\": [],\\\"realitySettings\\\": {\\\"show\\\": false,\\\"xver\\\": 0,\\\"dest\\\": \\\"yahoo.com:443\\\",\\\"serverNames\\\": [\\\"yahoo.com\\\",\\\"www.yahoo.com\\\"],\\\"privateKey\\\": \\\"wIc7zBUiTXBGxM7S7wl0nCZ663OAvzTDNqS7-bsxV3A\\\",\\\"minClient\\\": \\\"\\\",\\\"maxClient\\\": \\\"\\\",\\\"maxTimediff\\\": 0,\\\"shortIds\\\": [\\\"47595474\\\",\\\"7a5e30\\\",\\\"810c1efd750030e8\\\",\\\"99\\\",\\\"9c19c134b8\\\",\\\"35fd\\\",\\\"2409c639a707b4\\\",\\\"c98fc6b39f45\\\"],\\\"settings\\\": {\\\"publicKey\\\": \\\"2UqLjQFhlvLcY7VzaKRotIDQFOgAJe1dYD1njigp9wk\\\",\\\"fingerprint\\\": \\\"random\\\",\\\"serverName\\\": \\\"\\\",\\\"spiderX\\\": \\\"/\\\"}},\\\"tcpSettings\\\": {\\\"acceptProxyProtocol\\\": false,\\\"header\\\": {\\\"type\\\": \\\"none\\\"}}}\",\r\n\"sniffing\": \"{\\\"enabled\\\": true,\\\"destOverride\\\": [\\\"http\\\",\\\"tls\\\",\\\"quic\\\",\\\"fakedns\\\"],\\\"metadataOnly\\\": false,\\\"routeOnly\\\": false}\",\r\n\"allocate\": \"{\\\"strategy\\\": \\\"always\\\",\\\"refresh\\\": 5,\\\"concurrency\\\": 3}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/add","description":"Purpose: Create a new inbound.
\nPath: /panel/api/inbounds/add\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/add\"
-H \"Content-Type: application/json\" -H \"Cookie: \"
-d '{\"\": \"...\"}'
Success: 201 Created or 200 OK\nErrors: 400/422 (validation), 401/403, 429, 500.\nIdempotency: Not idempotent; creates a new resource.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","add"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"2399c67c-53d2-4857-a1b5-b13977c8283f","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"up\": 0,\r\n\t\"down\": 0,\r\n\t\"total\": 0,\r\n\t\"remark\": \"\",\r\n\t\"enable\": true,\r\n\t\"expiryTime\": 0,\r\n\t\"listen\": \"\",\r\n\t\"port\": 26139,\r\n\t\"protocol\": \"vless\",\r\n\t\"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"id\\\": \\\"20714ae1-db48-4202-9639-58237500127d\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"ajrzqcf9\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": \\\"\\\",\\n \\\"subId\\\": \\\"rzkhldokbw9ij6za\\\",\\n \\\"comment\\\": \\\"\\\",\\n \\\"reset\\\": 0\\n }\\n ],\\n \\\"decryption\\\": \\\"mlkem768x25519plus.native.600s.gGl-2HWuULvg_dyRSiZ8DjUJeE-PDFqJYoaiLirWG0o\\\",\\n \\\"encryption\\\": \\\"mlkem768x25519plus.native.0rtt.DgrUVBkM9R_Kl2Pr29tytuic7pXLw75uGhKYVWNZ5mw\\\",\\n \\\"selectedAuth\\\": \\\"X25519, not Post-Quantum\\\"\\n}\",\r\n\t\"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\r\n\t\"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 09 Sep 2025 10:35:45 GMT"},{"key":"Content-Length","value":"1392"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Inbound has been successfully created.\",\n \"obj\": {\n \"id\": 6,\n \"up\": 0,\n \"down\": 0,\n \"total\": 0,\n \"allTime\": 0,\n \"remark\": \"\",\n \"enable\": true,\n \"expiryTime\": 0,\n \"clientStats\": null,\n \"listen\": \"\",\n \"port\": 26139,\n \"protocol\": \"vless\",\n \"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"id\\\": \\\"20714ae1-db48-4202-9639-58237500127d\\\",\\n \\\"security\\\": \\\"\\\",\\n \\\"password\\\": \\\"\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"ajrzqcf9\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": 0,\\n \\\"subId\\\": \\\"rzkhldokbw9ij6za\\\",\\n \\\"comment\\\": \\\"\\\",\\n \\\"reset\\\": 0,\\n \\\"created_at\\\": 1757414145000,\\n \\\"updated_at\\\": 1757414145000\\n }\\n ],\\n \\\"decryption\\\": \\\"mlkem768x25519plus.native.600s.gGl-2HWuULvg_dyRSiZ8DjUJeE-PDFqJYoaiLirWG0o\\\",\\n \\\"encryption\\\": \\\"mlkem768x25519plus.native.0rtt.DgrUVBkM9R_Kl2Pr29tytuic7pXLw75uGhKYVWNZ5mw\\\",\\n \\\"selectedAuth\\\": \\\"X25519, not Post-Quantum\\\"\\n}\",\n \"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\n \"tag\": \"inbound-26139\",\n \"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\"\n }\n}"},{"id":"2173812d-6807-4f51-affd-e02b205dff71","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"up\": 0,\r\n\"down\": 0,\r\n\"total\": 0,\r\n\"remark\": \"New\",\r\n\"enable\": true,\r\n\"expiryTime\": 0,\r\n\"listen\": \"\",\r\n\"port\": 55421,\r\n\"protocol\": \"vless\",\r\n\"settings\": \"{\\\"clients\\\": [{\\\"id\\\": \\\"b86c0cdc-8a02-4da4-8693-72ba27005587\\\",\\\"flow\\\": \\\"\\\",\\\"email\\\": \\\"nt3wz904\\\",\\\"limitIp\\\": 0,\\\"totalGB\\\": 0,\\\"expiryTime\\\": 0,\\\"enable\\\": true,\\\"tgId\\\": \\\"\\\",\\\"subId\\\": \\\"rqv5zw1ydutamcp0\\\",\\\"reset\\\": 0}],\\\"decryption\\\": \\\"none\\\",\\\"fallbacks\\\": []}\",\r\n\"streamSettings\": \"{\\\"network\\\": \\\"tcp\\\",\\\"security\\\": \\\"reality\\\",\\\"externalProxy\\\": [],\\\"realitySettings\\\": {\\\"show\\\": false,\\\"xver\\\": 0,\\\"dest\\\": \\\"yahoo.com:443\\\",\\\"serverNames\\\": [\\\"yahoo.com\\\",\\\"www.yahoo.com\\\"],\\\"privateKey\\\": \\\"wIc7zBUiTXBGxM7S7wl0nCZ663OAvzTDNqS7-bsxV3A\\\",\\\"minClient\\\": \\\"\\\",\\\"maxClient\\\": \\\"\\\",\\\"maxTimediff\\\": 0,\\\"shortIds\\\": [\\\"47595474\\\",\\\"7a5e30\\\",\\\"810c1efd750030e8\\\",\\\"99\\\",\\\"9c19c134b8\\\",\\\"35fd\\\",\\\"2409c639a707b4\\\",\\\"c98fc6b39f45\\\"],\\\"settings\\\": {\\\"publicKey\\\": \\\"2UqLjQFhlvLcY7VzaKRotIDQFOgAJe1dYD1njigp9wk\\\",\\\"fingerprint\\\": \\\"random\\\",\\\"serverName\\\": \\\"\\\",\\\"spiderX\\\": \\\"/\\\"}},\\\"tcpSettings\\\": {\\\"acceptProxyProtocol\\\": false,\\\"header\\\": {\\\"type\\\": \\\"none\\\"}}}\",\r\n\"sniffing\": \"{\\\"enabled\\\": true,\\\"destOverride\\\": [\\\"http\\\",\\\"tls\\\",\\\"quic\\\",\\\"fakedns\\\"],\\\"metadataOnly\\\": false,\\\"routeOnly\\\": false}\",\r\n\"allocate\": \"{\\\"strategy\\\": \\\"always\\\",\\\"refresh\\\": 5,\\\"concurrency\\\": 3}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 13:54:54 GMT"},{"key":"Content-Length","value":"809"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Create Failed: Port already exists: 55421\\n\",\n \"obj\": {\n \"id\": 0,\n \"up\": 0,\n \"down\": 0,\n \"total\": 0,\n \"remark\": \"New\",\n \"enable\": true,\n \"expiryTime\": 0,\n \"clientStats\": null,\n \"listen\": \"\",\n \"port\": 55421,\n \"protocol\": \"vless\",\n \"settings\": \"{\\\"clients\\\": [{\\\"id\\\": \\\"b86c0cdc-8a02-4da4-8693-72ba27005587\\\",\\\"flow\\\": \\\"\\\",\\\"email\\\": \\\"nt3wz904\\\",\\\"limitIp\\\": 0,\\\"totalGB\\\": 0,\\\"expiryTime\\\": 0,\\\"enable\\\": true,\\\"tgId\\\": \\\"\\\",\\\"subId\\\": \\\"rqv5zw1ydutamcp0\\\",\\\"reset\\\": 0}],\\\"decryption\\\": \\\"none\\\",\\\"fallbacks\\\": []}\",\n \"streamSettings\": \"{\\\"network\\\": \\\"tcp\\\",\\\"security\\\": \\\"reality\\\",\\\"externalProxy\\\": [],\\\"realitySettings\\\": {\\\"show\\\": false,\\\"xver\\\": 0,\\\"dest\\\": \\\"yahoo.com:443\\\",\\\"serverNames\\\": [\\\"yahoo.com\\\",\\\"www.yahoo.com\\\"],\\\"privateKey\\\": \\\"wIc7zBUiTXBGxM7S7wl0nCZ663OAvzTDNqS7-bsxV3A\\\",\\\"minClient\\\": \\\"\\\",\\\"maxClient\\\": \\\"\\\",\\\"maxTimediff\\\": 0,\\\"shortIds\\\": [\\\"47595474\\\",\\\"7a5e30\\\",\\\"810c1efd750030e8\\\",\\\"99\\\",\\\"9c19c134b8\\\",\\\"35fd\\\",\\\"2409c639a707b4\\\",\\\"c98fc6b39f45\\\"],\\\"settings\\\": {\\\"publicKey\\\": \\\"2UqLjQFhlvLcY7VzaKRotIDQFOgAJe1dYD1njigp9wk\\\",\\\"fingerprint\\\": \\\"random\\\",\\\"serverName\\\": \\\"\\\",\\\"spiderX\\\": \\\"/\\\"}},\\\"tcpSettings\\\": {\\\"acceptProxyProtocol\\\": false,\\\"header\\\": {\\\"type\\\": \\\"none\\\"}}}\",\n \"tag\": \"inbound-55421\",\n \"sniffing\": \"{\\\"enabled\\\": true,\\\"destOverride\\\": [\\\"http\\\",\\\"tls\\\",\\\"quic\\\",\\\"fakedns\\\"],\\\"metadataOnly\\\": false,\\\"routeOnly\\\": false}\",\n \"allocate\": \"{\\\"strategy\\\": \\\"always\\\",\\\"refresh\\\": 5,\\\"concurrency\\\": 3}\"\n }\n}"}],"_postman_id":"1315bbf2-f8e2-4c35-bf50-adf10cd8c752"},{"name":"Add Client to inbound","id":"ac2573ee-4360-4a3c-9041-16c4671a525a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"6","type":"text"},{"key":"settings","value":"{\"clients\": [{\n \"id\": \"06c3c327-c619-4998-9bb3-adaced38c68b\",\n \"flow\": \"\",\n \"email\": \"5atat4da\",\n \"limitIp\": 0,\n \"totalGB\": 0,\n \"expiryTime\": 0,\n \"enable\": true,\n \"tgId\": \"\",\n \"subId\": \"86xi6py5uwsgokh1\",\n \"comment\": \"\",\n \"reset\": 0\n}]}","type":"text","uuid":"ae2fbde2-65bb-4160-8c11-6b8e0a4fb6e7"}]},"url":"http://localhost:2053/randompath/panel/api/inbounds/addClient","description":"Purpose: Add a client to an inbound.
\nPath: /panel/api/inbounds/addClient\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/addClient\"
-H \"Content-Type: application/json\" -H \"Cookie: \"
-d '{\"inboundId\":\"\",\"client\":{...}}'
Success: 200 OK or 201 Created\nErrors: 400/422 (validation), 401/403, 404 (inbound not found), 429, 500.\nIdempotency: Not idempotent; creates or mutates client list.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","addClient"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"95c2698b-8cc2-4d7b-947d-646408104c79","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"6","type":"text"},{"key":"settings","value":"{\"clients\": [{\n \"id\": \"06c3c327-c619-4998-9bb3-adaced38c68b\",\n \"flow\": \"\",\n \"email\": \"5atat4da\",\n \"limitIp\": 0,\n \"totalGB\": 0,\n \"expiryTime\": 0,\n \"enable\": true,\n \"tgId\": \"\",\n \"subId\": \"86xi6py5uwsgokh1\",\n \"comment\": \"\",\n \"reset\": 0\n}]}","type":"text","uuid":"ae2fbde2-65bb-4160-8c11-6b8e0a4fb6e7"}],"options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/addClient"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Sep 2025 11:05:15 GMT"},{"key":"Content-Length","value":"70"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Inbound client(s) have been added.\",\n \"obj\": null\n}"},{"id":"87325db5-e9ba-4de4-b1eb-1da8aa69452d","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": 5,\r\n\t\"settings\": \"{\\\"clients\\\": [{\\\"id\\\": \\\"bbfad557-28f2-47e5-9f3d-e3c7f532fbda\\\",\\\"flow\\\": \\\"\\\",\\\"email\\\": \\\"dp1plmlt8\\\",\\\"limitIp\\\": 0,\\\"totalGB\\\": 0,\\\"expiryTime\\\": 0,\\\"enable\\\": true,\\\"tgId\\\": \\\"\\\",\\\"subId\\\": \\\"2rv0gb458kbfl532\\\",\\\"reset\\\": 0}]}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/addClient"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:03:18 GMT"},{"key":"Content-Length","value":"112"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Something went wrong! Failed: Duplicate email: dp1plmlt8\\n\",\n \"obj\": null\n}"}],"_postman_id":"ac2573ee-4360-4a3c-9041-16c4671a525a"},{"name":"Update Inbound","id":"fd9c69da-8617-4fd0-8deb-e5beb7cc7319","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"up\": 0,\r\n\t\"down\": 0,\r\n\t\"total\": 0,\r\n\t\"remark\": \"\",\r\n\t\"enable\": true,\r\n\t\"expiryTime\": 0,\r\n\t\"listen\": \"\",\r\n\t\"port\": 44360,\r\n\t\"protocol\": \"vless\",\r\n\t\"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"id\\\": \\\"a39c9655-bcbb-43c4-9b3b-ebd8b7ae9e1e\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"s729v2km\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": \\\"\\\",\\n \\\"subId\\\": \\\"n2b9ubaioe06cak8\\\",\\n \\\"reset\\\": 0\\n }\\n ],\\n \\\"decryption\\\": \\\"none\\\",\\n \\\"fallbacks\\\": []\\n}\",\r\n\t\"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\r\n\t\"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\",\r\n\t\"allocate\": \"{\\n \\\"strategy\\\": \\\"always\\\",\\n \\\"refresh\\\": 5,\\n \\\"concurrency\\\": 3\\n}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/update/{inboundId}","description":"Purpose: Update an existing inbound by ID.
\nPath: /panel/api/inbounds/update/{inboundId}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/update/{inboundId}\"
-H \"Content-Type: application/json\" -H \"Cookie: \"
-d '{\"\": \"\"}'
Success: 200 OK\nErrors: 400/422, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; mutates resource.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","update","{inboundId}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3f563703-2fca-4a8e-b028-d9b9fa2a68aa","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"up\": 0,\r\n\t\"down\": 0,\r\n\t\"total\": 0,\r\n\t\"remark\": \"\",\r\n\t\"enable\": true,\r\n\t\"expiryTime\": 0,\r\n\t\"listen\": \"\",\r\n\t\"port\": 26139,\r\n\t\"protocol\": \"vless\",\r\n\t\"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"id\\\": \\\"20714ae1-db48-4202-9639-58237500127d\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"ajrzqcf9\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": 0,\\n \\\"subId\\\": \\\"rzkhldokbw9ij6za\\\",\\n \\\"comment\\\": \\\"\\\",\\n \\\"reset\\\": 0,\\n \\\"created_at\\\": 1757414145000,\\n \\\"updated_at\\\": 1757414145000\\n }\\n ],\\n \\\"decryption\\\": \\\"mlkem768x25519plus.native.600s.gGl-2HWuULvg_dyRSiZ8DjUJeE-PDFqJYoaiLirWG0o\\\",\\n \\\"encryption\\\": \\\"mlkem768x25519plus.native.0rtt.DgrUVBkM9R_Kl2Pr29tytuic7pXLw75uGhKYVWNZ5mw\\\",\\n \\\"selectedAuth\\\": \\\"X25519, not Post-Quantum\\\"\\n}\",\r\n\t\"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\r\n\t\"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/update/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 09 Sep 2025 10:38:00 GMT"},{"key":"Content-Length","value":"1325"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Inbound has been successfully updated.\",\n \"obj\": {\n \"id\": 6,\n \"up\": 0,\n \"down\": 0,\n \"total\": 0,\n \"allTime\": 0,\n \"remark\": \"\",\n \"enable\": true,\n \"expiryTime\": 0,\n \"clientStats\": null,\n \"listen\": \"\",\n \"port\": 26139,\n \"protocol\": \"vless\",\n \"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"comment\\\": \\\"\\\",\\n \\\"created_at\\\": 1757414145000,\\n \\\"email\\\": \\\"ajrzqcf9\\\",\\n \\\"enable\\\": true,\\n \\\"expiryTime\\\": 0,\\n \\\"flow\\\": \\\"\\\",\\n \\\"id\\\": \\\"20714ae1-db48-4202-9639-58237500127d\\\",\\n \\\"limitIp\\\": 0,\\n \\\"reset\\\": 0,\\n \\\"subId\\\": \\\"rzkhldokbw9ij6za\\\",\\n \\\"tgId\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"updated_at\\\": 1757414145000\\n }\\n ],\\n \\\"decryption\\\": \\\"mlkem768x25519plus.native.600s.gGl-2HWuULvg_dyRSiZ8DjUJeE-PDFqJYoaiLirWG0o\\\",\\n \\\"encryption\\\": \\\"mlkem768x25519plus.native.0rtt.DgrUVBkM9R_Kl2Pr29tytuic7pXLw75uGhKYVWNZ5mw\\\",\\n \\\"selectedAuth\\\": \\\"X25519, not Post-Quantum\\\"\\n}\",\n \"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\n \"tag\": \"\",\n \"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\"\n }\n}"},{"id":"006e97bd-1841-47a3-9347-5f39064d2a7f","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"up\": 0,\r\n\t\"down\": 0,\r\n\t\"total\": 0,\r\n\t\"remark\": \"\",\r\n\t\"enable\": true,\r\n\t\"expiryTime\": 0,\r\n\t\"listen\": \"\",\r\n\t\"port\": 44322,\r\n\t\"protocol\": \"vless\",\r\n\t\"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"id\\\": \\\"a39c9655-bcbb-43c4-9b3b-ebd8b7ae9e1e\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"s729v2km\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": \\\"\\\",\\n \\\"subId\\\": \\\"n2b9ubaioe06cak8\\\",\\n \\\"reset\\\": 0\\n }\\n ],\\n \\\"decryption\\\": \\\"none\\\",\\n \\\"fallbacks\\\": []\\n}\",\r\n\t\"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\r\n\t\"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\",\r\n\t\"allocate\": \"{\\n \\\"strategy\\\": \\\"always\\\",\\n \\\"refresh\\\": 5,\\n \\\"concurrency\\\": 3\\n}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/update/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:12:37 GMT"},{"key":"Content-Length","value":"542"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Update Failed: record not found\",\n \"obj\": {\n \"id\": 6,\n \"up\": 0,\n \"down\": 0,\n \"total\": 0,\n \"remark\": \"\",\n \"enable\": true,\n \"expiryTime\": 0,\n \"clientStats\": null,\n \"listen\": \"\",\n \"port\": 44322,\n \"protocol\": \"vless\",\n \"settings\": \"{\\n \\\"clients\\\": [\\n {\\n \\\"id\\\": \\\"a39c9655-bcbb-43c4-9b3b-ebd8b7ae9e1e\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"s729v2km\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": \\\"\\\",\\n \\\"subId\\\": \\\"n2b9ubaioe06cak8\\\",\\n \\\"reset\\\": 0\\n }\\n ],\\n \\\"decryption\\\": \\\"none\\\",\\n \\\"fallbacks\\\": []\\n}\",\n \"streamSettings\": \"{\\n \\\"network\\\": \\\"tcp\\\",\\n \\\"security\\\": \\\"none\\\",\\n \\\"externalProxy\\\": [],\\n \\\"tcpSettings\\\": {\\n \\\"acceptProxyProtocol\\\": false,\\n \\\"header\\\": {\\n \\\"type\\\": \\\"none\\\"\\n }\\n }\\n}\",\n \"tag\": \"\",\n \"sniffing\": \"{\\n \\\"enabled\\\": false,\\n \\\"destOverride\\\": [\\n \\\"http\\\",\\n \\\"tls\\\",\\n \\\"quic\\\",\\n \\\"fakedns\\\"\\n ],\\n \\\"metadataOnly\\\": false,\\n \\\"routeOnly\\\": false\\n}\",\n \"allocate\": \"{\\n \\\"strategy\\\": \\\"always\\\",\\n \\\"refresh\\\": 5,\\n \\\"concurrency\\\": 3\\n}\"\n }\n}"}],"_postman_id":"fd9c69da-8617-4fd0-8deb-e5beb7cc7319"},{"name":"Update Client","id":"fa89923a-7e84-4723-98ba-f737dde67144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": 20,\r\n\t\"settings\": \"{\\\"clients\\\": [{\\\"id\\\": \\\"6046007d-f4e5-4384-a545-2848165001da\\\",\\\"flow\\\": \\\"\\\",\\\"email\\\": \\\"sbhmrsmz\\\",\\\"limitIp\\\": 0,\\\"totalGB\\\": 10737418240,\\\"expiryTime\\\": 1729073736270,\\\"enable\\\": true,\\\"tgId\\\": \\\"\\\",\\\"subId\\\": \\\"z70791vpexfxw57h\\\",\\\"reset\\\": 0}]}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/updateClient/{uuid}","description":"Purpose: Update an existing client by UUID.
\nPath: /panel/api/inbounds/updateClient/{uuid}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/updateClient/{uuid}\"
-H \"Content-Type: application/json\" -H \"Cookie: \"
-d '{\"\": \"\"}'
Success: 200 OK\nErrors: 400/422, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; mutates resource.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","updateClient","{uuid}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"187f59c6-f56c-41df-8aa1-2ca2c04edeb5","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": 6,\r\n\t\"settings\": \"{\\\"clients\\\": [{\\n \\\"id\\\": \\\"20714ae1-db48-4202-9639-58237500127d\\\",\\n \\\"flow\\\": \\\"\\\",\\n \\\"email\\\": \\\"ajrzqcf9\\\",\\n \\\"limitIp\\\": 0,\\n \\\"totalGB\\\": 0,\\n \\\"expiryTime\\\": 0,\\n \\\"enable\\\": true,\\n \\\"tgId\\\": 0,\\n \\\"subId\\\": \\\"rzkhldokbw9ij6za\\\",\\n \\\"comment\\\": \\\"\\\",\\n \\\"reset\\\": 0,\\n \\\"created_at\\\": 1757414145000,\\n \\\"updated_at\\\": 1757414342000\\n}]}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/updateClient/20714ae1-db48-4202-9639-58237500127d"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 09 Sep 2025 10:40:16 GMT"},{"key":"Content-Length","value":"68"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Inbound client has been updated.\",\n \"obj\": null\n}"},{"id":"50ec25d2-d2eb-4105-bc51-eb06a17b399d","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 3,\r\n \"settings\": \"{\\\"clients\\\":[{\\\"id\\\":\\\"95e4e7bb-7796-47e7-e8a7-f4055194f776\\\",\\\"alterId\\\":0,\\\"email\\\":\\\"test123\\\",\\\"limitIp\\\":2,\\\"totalGB\\\":42949672960,\\\"expiryTime\\\":1682864675944,\\\"enable\\\":true,\\\"tgId\\\":\\\"\\\",\\\"subId\\\":\\\"\\\"}]}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/updateClient/fake uuid"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:15:08 GMT"},{"key":"Content-Length","value":"106"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Something went wrong! Failed: empty client ID\\n\",\n \"obj\": null\n}"}],"_postman_id":"fa89923a-7e84-4723-98ba-f737dde67144"},{"name":"Clear Client Ip address","id":"6d16599f-916e-45d7-ac71-aad4ed1cb439","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/clearClientIps/{email}","description":"Purpose: Clear stored client IP addresses by email.
\nPath: /panel/api/inbounds/clearClientIps/{email}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/clearClientIps/{email}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; deletes stored IPs (destructive).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","clearClientIps","{email}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"fc3ecfa9-5359-47c4-99fc-1b2e27f58fcc","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/clearClientIps/27225ost"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:16:28 GMT"},{"key":"Content-Length","value":"80"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Log Cleared Successfully\",\n \"obj\": null\n}"}],"_postman_id":"6d16599f-916e-45d7-ac71-aad4ed1cb439"},{"name":"Reset traffics of all inbounds","id":"0475fe17-9c8b-4638-b704-2c17ab780121","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/resetAllTraffics","description":"Purpose: Reset traffic counters for all inbounds.
\nPath: /panel/api/inbounds/resetAllTraffics\nQuery: none
\nParams: none
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/resetAllTraffics\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 401/403, 429, 500.\nIdempotency: Not idempotent; resets counters globally.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","resetAllTraffics"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"44cc96a5-7136-48f3-9655-e23c50bfd622","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/resetAllTraffics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:17:07 GMT"},{"key":"Content-Length","value":"93"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"all traffic has been reset Successfully\",\n \"obj\": null\n}"}],"_postman_id":"0475fe17-9c8b-4638-b704-2c17ab780121"},{"name":"Reset traffics of all clients in an inbound","id":"6746a441-d6c5-4bf9-a1c5-d1cf177c2c1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/resetAllClientTraffics/{inboundId}","description":"Purpose: Reset traffic counters for all clients in a specific inbound.
\nPath: /panel/api/inbounds/resetAllClientTraffics/{inboundId}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/resetAllClientTraffics/{inboundId}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 401/403, 404, 429, 500.\nIdempotency: Not idempotent; resets counters for clients under the inbound.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","resetAllClientTraffics","{inboundId}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d9566ab3-f7e6-40ec-9263-61361f263015","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/resetAllClientTraffics/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:17:39 GMT"},{"key":"Content-Length","value":"107"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"All traffic from the client has been reset. Successfully\",\n \"obj\": null\n}"}],"_postman_id":"6746a441-d6c5-4bf9-a1c5-d1cf177c2c1c"},{"name":"Reset Client Traffic","id":"0e6e3654-7bb3-4008-9c95-ccc2591be1a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/inbounds/{inboundId}/resetClientTraffic/{email}","description":"Purpose: Reset a single client’s traffic in a specific inbound by email.
\nPath: /panel/api/inbounds/{inboundId}/resetClientTraffic/{email}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/{inboundId}/resetClientTraffic/{email}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; resets client’s counters.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","{inboundId}","resetClientTraffic","{email}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"1f71e13d-08ae-44db-9af0-2c2a1c5fe0d0","name":"success","originalRequest":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/inbounds/3/resetClientTraffic/27225ost"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:18:46 GMT"},{"key":"Content-Length","value":"91"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Traffic has been reset Successfully\",\n \"obj\": null\n}"}],"_postman_id":"0e6e3654-7bb3-4008-9c95-ccc2591be1a1"},{"name":"Delete Client","id":"131b13f8-e332-452c-9328-881ec3ae661a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/{inboundId}/delClient/{uuid}","description":"Purpose: Delete a client from an inbound by UUID.
\nPath: /panel/api/inbounds/{inboundId}/delClient/{uuid}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/{inboundId}/delClient/{uuid}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; deletes client (destructive).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","{inboundId}","delClient","{uuid}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"33a4376c-6e8b-44b7-b994-695cbff0515b","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/3/delClient/bf036995-a81d-41b3-8e06-8e233418c96a"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:20:24 GMT"},{"key":"Content-Length","value":"83"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Client deleted Successfully\",\n \"obj\": null\n}"},{"id":"1aacfd8d-b41a-408a-b742-c41abd398571","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/2/delClient/95e2b7bb-7796-47e7-e8a7-f4055194f433"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:20:48 GMT"},{"key":"Content-Length","value":"101"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Something went wrong! Failed: record not found\",\n \"obj\": null\n}"}],"_postman_id":"131b13f8-e332-452c-9328-881ec3ae661a"},{"name":"Delete Inbound","id":"b35612e3-a3bd-4aec-9cca-162427ef2a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/del/{inboundId}","description":"Purpose: Delete an inbound by ID.
\nPath: /panel/api/inbounds/del/{inboundId}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/del/{inboundId}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; deletes resource (destructive).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","del","{inboundId}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"99695e45-a9d0-4358-87d0-7be5118e3340","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/del/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:21:26 GMT"},{"key":"Content-Length","value":"72"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Delete Successfully\",\n \"obj\": 3\n}"},{"id":"72de855e-d1a0-4100-b818-26ec600b9835","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/del/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:21:34 GMT"},{"key":"Content-Length","value":"89"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"msg\": \"Delete Failed: record not found\",\n \"obj\": 3\n}"}],"_postman_id":"b35612e3-a3bd-4aec-9cca-162427ef2a33"},{"name":"Delete Depleted Clients","id":"ac7083c9-9719-4562-859c-01c690a5d08d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/randompath/panel/api/inbounds/delDepletedClients/{inboundId}","description":"Purpose: Delete all depleted clients under an inbound.
\nPath: /panel/api/inbounds/delDepletedClients/{inboundId}\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/delDepletedClients/{inboundId}\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 400, 401/403, 404, 429, 500.\nIdempotency: Not idempotent; bulk deletion (destructive).
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","delDepletedClients","{inboundId}"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"39d6169a-0536-4467-87ab-285aaa0752b9","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:2053/panel/api/inbounds/delDepletedClients/4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:22:23 GMT"},{"key":"Content-Length","value":"97"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"All depleted clients are deleted Successfully\",\n \"obj\": null\n}"}],"_postman_id":"ac7083c9-9719-4562-859c-01c690a5d08d"},{"name":"Online Clients","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"bef33936-3edd-451b-840c-e391e8018084"}}],"id":"5ff2f31f-6ee6-4093-9e65-e2f0420b06ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:2053/randompath/panel/api/inbounds/onlines","description":"Purpose: Get list of online clients across inbounds.
\nPath: /panel/api/inbounds/onlines\nQuery: none
\nParams: none
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/onlines\" -H \"Cookie: \"
\nSuccess: 200 OK\nErrors: 401/403, 429, 500.\nIdempotency: Read-like but uses POST; no side effects expected.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","onlines"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"1e63f528-9d79-48f7-a414-a0ecb0d8300b","name":"Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:2053/randompath/panel/api/inbounds/onlines"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 17 Oct 2024 14:26:49 GMT"},{"key":"Content-Length","value":"68"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\n \"88vzckui\"\n ]\n}"}],"_postman_id":"5ff2f31f-6ee6-4093-9e65-e2f0420b06ec"},{"name":"import inbound","id":"dd184c01-28b9-403f-9430-2c8ad26405b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:2053/randompath/panel/api/inbounds/import","description":"Purpose: Import an inbound configuration from payload.
\nPath: /panel/api/inbounds/import\nQuery: none
\nParams:
\nEnvironment variables: localhost, 2053, /randompath\nAuth: Requires authenticated admin session/token.
\nExample:\ncurl -X POST \"http://localhost:2053/randompath/panel/api/inbounds/import\"
-H \"Content-Type: application/json\" -H \"Cookie: \"
-d '{\"data\": \"...\"}'
Success: 200 OK or 201 Created\nErrors: 400/422, 401/403, 429, 500.\nIdempotency: Not idempotent; creates or mutates resources.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","inbounds","import"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd184c01-28b9-403f-9430-2c8ad26405b9"},{"name":"last Online","id":"4b6f40df-39cb-4cd1-abce-6d0b952928dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2053/panel/api/inbounds/lastOnline","description":"This API endpoint retrieves the last online status of inbound connections. It is useful for monitoring the availability and performance of various inbound services within the system.
\nMethod: POST
\nURL: http://localhost:2053/panel/api/inbounds/lastOnline
The request does not require any input parameters in the body.
\nThe response will be in JSON format and includes the following structure:
\nsuccess: A boolean indicating whether the request was successful.
\nmsg: A string that may contain a message related to the request (usually empty).
\nobj: This field can have different structures based on the context:
\nIf the last online status is available, it will contain an object with the identifier of the inbound connection and its last online status (e.g., {\"lb0n0jx2\":0}).
If there are no inbound connections or the status is not available, it may return null.
In related responses, the obj can also contain an array of objects with detailed statistics about each inbound connection, including metrics such as up, down, total, allTime, and lastOnline timestamps.
{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"lb0n0jx2\": 0\n }\n}\n\nThis endpoint is essential for tracking the operational status of inbound connections and can be used in conjunction with other API endpoints that provide detailed statistics about connection performance.
\n","urlObject":{"protocol":"http","port":"2053","path":["panel","api","inbounds","lastOnline"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"828a4768-ea65-456a-b103-94185454e72b","name":"success","originalRequest":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/inbounds/lastOnline"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sat, 13 Sep 2025 21:07:33 GMT"},{"key":"Content-Length","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"lb0n0jx2\": 1757797563004\n }\n}"}],"_postman_id":"4b6f40df-39cb-4cd1-abce-6d0b952928dd"},{"name":"del Client By Email","id":"0015b58f-9153-43f8-be32-0c35478f0570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/inbounds/{id}/delClientByEmail/{email}","description":"This endpoint allows you to delete a client by their email address from a specified inbound configuration. It is useful for managing client access and ensuring that only authorized users are retained within the system.
\nPOST
http://localhost:2053/panel/api/inbounds/{id}/delClientByEmail/{email}
id (string): The unique identifier of the inbound configuration from which the client will be deleted.
\nemail (string): The email address of the client to be deleted.
\nThis endpoint does not require a request body.
\nThe response will be in JSON format and will contain the following fields:
\nsuccess (boolean): Indicates whether the operation was successful.
\nmsg (string): A message providing additional information about the operation (can be empty).
\nobj (object or null): Contains the details of the operation. It may return null if there are no additional details.
{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": null\n}\n\nThe structure of the response is consistent with other endpoints in the API, which may return similar success messages and object structures. For example:
\nEnsure that the provided email corresponds to an existing client associated with the specified inbound configuration.
\nA successful response does not guarantee that the client was found; it only indicates that the request was processed without errors.
\nThis endpoint retrieves the current status of the server, providing various metrics related to CPU, memory, disk usage, network traffic, and application statistics.
\nMethod: GET
\nURL: http://localhost:2053/randompath/panel/api/server/status
The response will be a JSON object containing the following fields:
\nsuccess (boolean): Indicates whether the request was successful.
\nmsg (string): A message providing additional information about the request status.
\nobj (object): An object containing detailed server metrics:
\ncpu (integer): The current CPU usage percentage.
\ncpuCores (integer): The number of CPU cores available.
\nlogicalPro (integer): The number of logical processors.
\ncpuSpeedMhz (integer): The speed of the CPU in MHz.
\nmem (object): Memory usage details:
\ncurrent (integer): Current memory usage in bytes.
\ntotal (integer): Total memory available in bytes.
\nswap (object): Swap memory details:
\ncurrent (integer): Current swap usage in bytes.
\ntotal (integer): Total swap available in bytes.
\ndisk (object): Disk usage details:
\ncurrent (integer): Current disk usage in bytes.
\ntotal (integer): Total disk space available in bytes.
\nxray (object): X-ray service status:
\nstate (string): Current state of the X-ray service.
\nerrorMsg (string): Error message if applicable.
\nversion (string): Version of the X-ray service.
\nuptime (integer): Server uptime in seconds.
\nloads (array): Current load averages.
\ntcpCount (integer): Number of active TCP connections.
\nudpCount (integer): Number of active UDP connections.
\nnetIO (object): Network I/O statistics:
\nup (integer): Data sent in bytes.
\ndown (integer): Data received in bytes.
\nnetTraffic (object): Network traffic statistics:
\nsent (integer): Total data sent in bytes.
\nrecv (integer): Total data received in bytes.
\npublicIP (object): Public IP addresses:
\nipv4 (string): IPv4 address.
\nipv6 (string): IPv6 address.
\nappStats (object): Application statistics:
\nthreads (integer): Number of active threads.
\nmem (integer): Memory used by the application in bytes.
\nuptime (integer): Application uptime in seconds.
\nA successful response will return a 200 status code.
\nThe structure of the response may vary, as some calls to other endpoints may return null or an array in the obj field, but the success and msg fields will remain consistent.
GET
http://localhost:2053/randompath/panel/api/server/getDb
This endpoint retrieves the current database status and server metrics. It provides insights into the server's CPU, memory, disk usage, network statistics, and application statistics. The response will include various metrics that can be used to monitor the health and performance of the server.
\nThere are no request parameters required for this endpoint.
\nThe response will be in JSON format and will include the following structure:
\nsuccess: A boolean indicating the success of the request.
\nmsg: A message string that may contain additional information (usually empty).
\nobj: An object containing server metrics or null if no data is available. The metrics include:
\ncpu: Current CPU usage.
\ncpuCores: Number of CPU cores.
\nlogicalPro: Number of logical processors.
\ncpuSpeedMhz: CPU speed in MHz.
\nmem: Memory usage details:
\ncurrent: Current memory usage.
\ntotal: Total memory available.
\nswap: Swap memory details:
\ncurrent: Current swap usage.
\ntotal: Total swap available.
\ndisk: Disk usage details:
\ncurrent: Current disk usage.
\ntotal: Total disk space available.
\nxray: Xray service status:
\nstate: Current state of the Xray service.
\nerrorMsg: Any error message related to Xray.
\nversion: Version of the Xray service.
\nuptime: Server uptime in seconds.
\nloads: Array of load averages.
\ntcpCount: Number of active TCP connections.
\nudpCount: Number of active UDP connections.
\nnetIO: Network I/O statistics:
\nup: Data sent.
\ndown: Data received.
\nnetTraffic: Network traffic statistics:
\nsent: Total data sent.
\nrecv: Total data received.
\npublicIP: Public IP addresses:
\nipv4: IPv4 address.
\nipv6: IPv6 address.
\nappStats: Application statistics:
\nthreads: Number of threads used by the application.
\nmem: Memory usage by the application.
\nuptime: Uptime of the application.
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"cpu\": 0,\n \"cpuCores\": 0,\n \"logicalPro\": 0,\n \"cpuSpeedMhz\": 0,\n \"mem\": {\n \"current\": 0,\n \"total\": 0\n },\n \"swap\": {\n \"current\": 0,\n \"total\": 0\n },\n \"disk\": {\n \"current\": 0,\n \"total\": 0\n },\n \"xray\": {\n \"state\": \"\",\n \"errorMsg\": \"\",\n \"version\": \"\"\n },\n \"uptime\": 0,\n \"loads\": [0],\n \"tcpCount\": 0,\n \"udpCount\": 0,\n \"netIO\": {\n \"up\": 0,\n \"down\": 0\n },\n \"netTraffic\": {\n \"sent\": 0,\n \"recv\": 0\n },\n \"publicIP\": {\n \"ipv4\": \"\",\n \"ipv6\": \"\"\n },\n \"appStats\": {\n \"threads\": 0,\n \"mem\": 0,\n \"uptime\": 0\n }\n }\n}\n\nThis endpoint retrieves the current version of the Xray service running on the server. It is a simple HTTP GET request that does not require any parameters.
\nMethod: GET
\nURL: http://localhost:2053/randompath/panel/api/server/getXrayVersion
The response will be in JSON format and will contain the following fields:
\nsuccess (boolean): Indicates whether the request was successful.
\nmsg (string): A message providing additional information about the request.
\nobj (array or null): Contains the version information of Xray. If the version is not available, this field may return null.
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\"\"]\n}\n\nA successful response will return a 200 HTTP status code.
\nThe obj field may contain an array with version details or may be null depending on the availability of the information.
This endpoint is related to other server status endpoints which may return similar response structures, such as CPU, memory, and network statistics.
\nThis endpoint is useful for monitoring and managing the Xray service version on the server.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","getXrayVersion"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"90114a56-e115-42b1-86e4-82b772d905f0","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getXrayVersion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 22:15:38 GMT"},{"key":"Content-Length","value":"75"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\n \"v25.9.5\",\n \"v25.8.31\",\n \"v25.8.29\",\n \"v25.8.3\"\n ]\n}"}],"_postman_id":"f3755c17-ebe7-4dff-9152-393ad24c1556"},{"name":"get Config Json","id":"c2c28056-df81-4bc5-814f-441c116a7dc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getConfigJson","description":"This endpoint retrieves the configuration settings of the server in JSON format. It provides detailed information about various server parameters, including API services, inbounds, outbounds, logging settings, metrics, and routing rules.
\nMethod: GET
\nURL: http://localhost:2053/randompath/panel/api/server/getConfigJson
Request Body: None (This is a GET request)
\nThe response is a JSON object containing the following fields:
\nsuccess: A boolean indicating the success of the request.
\nmsg: A string that may contain a message related to the request (usually empty).
\nobj: An object containing the configuration details, structured as follows:
\napi: Contains information about API services.
\nservices: An array of service names.
\ntag: A string representing the tag.
\nburstObservatory: Can be null or contain observatory details.
\ndns: Can be null or contain DNS settings.
\nfakedns: Can be null or contain fake DNS settings.
\ninbounds: An array of inbound configurations, each including:
\nlisten: The address to listen on.
\nport: The port number.
\nprotocol: The protocol used.
\nsettings: An object with additional settings, such as address.
\nsniffing: Can be null or contain sniffing settings.
\nstreamSettings: Can be null or contain stream settings.
\ntag: A string representing the tag.
\nlog: An object containing logging settings.
\naccess: The access log setting.
\ndnsLog: A boolean indicating if DNS logging is enabled.
\nerror: The error log setting.
\nloglevel: The log level setting.
\nmaskAddress: The address masking setting.
\nmetrics: Contains metrics configuration.
\nlisten: The address to listen for metrics.
\ntag: A string representing the tag.
\nobservatory: Can be null or contain observatory settings.
\noutbounds: An array of outbound configurations, each including:
\nprotocol: The protocol used.
\nsettings: An object with additional settings, such as domain strategy.
\ntag: A string representing the tag.
\npolicy: Contains policy settings, including:
\nreverse: Can be null or contain reverse proxy settings.
\nrouting: Contains routing configurations.
\ndomainStrategy: The strategy for domain routing.
\nrules: An array of routing rules.
\nstats: An object containing statistics.
\ntransport: Can be null or contain transport settings.
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"api\": {\n \"services\": [\"\"],\n \"tag\": \"\"\n },\n \"burstObservatory\": null,\n \"dns\": null,\n \"fakedns\": null,\n \"inbounds\": [\n {\n \"listen\": \"\",\n \"port\": 0,\n \"protocol\": \"\",\n \"settings\": {\n \"address\": \"\"\n },\n \"sniffing\": null,\n \"streamSettings\": null,\n \"tag\": \"\"\n }\n ],\n \"log\": {\n \"access\": \"\",\n \"dnsLog\": true,\n \"error\": \"\",\n \"loglevel\": \"\",\n \"maskAddress\": \"\"\n },\n \"metrics\": {\n \"listen\": \"\",\n \"tag\": \"\"\n },\n \"observatory\": null,\n \"outbounds\": [\n {\n \"protocol\": \"\",\n \"settings\": {\n \"domainStrategy\": \"\",\n \"noises\": [],\n \"redirect\": \"\"\n },\n \"tag\": \"\"\n }\n ],\n \"policy\": {\n \"levels\": {\n \"0\": {\n \"statsUserDownlink\": true,\n \"statsUserUplink\": true\n }\n },\n \"system\": {\n \"statsInboundDownlink\": true,\n \"statsInboundUplink\": true,\n \"statsOutboundDownlink\": true,\n \"statsOutboundUplink\": true\n }\n },\n \"reverse\": null,\n \"routing\": {\n \"domainStrategy\": \"\",\n \"rules\": [\n {\n \"inboundTag\": [\"\"],\n \"outboundTag\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"stats\": {},\n \"transport\": null\n }\n}\n\nThis endpoint retrieves the CPU history data for a specified time bucket from the server. It provides insights into CPU usage over time, which can be useful for monitoring and performance analysis.
\nMethod: GET
\nURL: http://localhost:2053/panel/api/server/cpuHistory/{bucket}
Path Parameter:
\nbucket (string): This parameter specifies the time bucket for which the CPU history is requested. The format and acceptable values for this parameter should be defined based on the API's requirements.Status Code: 200 OK
\nContent-Type: application/json
\nResponse Structure:
\nsuccess (boolean): Indicates whether the request was successful.
msg (string): A message providing additional information about the request. This may be empty if there are no issues.
obj (array or null): Contains the CPU history data. Each entry in the array has the following structure:
cpu (integer): Represents the CPU usage value.
t (integer): Represents the timestamp associated with the CPU usage value.
{ \"success\": true, \"msg\": \"\", \"obj\": [ { \"cpu\": 0, \"t\": 0 } ]}
\n{ \"success\": true, \"msg\": \"\", \"obj\": null }
\nThis endpoint is essential for obtaining real-time CPU usage statistics, which can help in diagnosing performance issues and understanding system load over specified periods. It is important to note that the obj field may return either an array of CPU usage records or null, depending on the availability of data for the requested time bucket. Ensure to handle both scenarios in your application logic.
This endpoint retrieves a new universally unique identifier (UUID) from the server. It is typically used to generate a unique identifier for various purposes within the application, such as session management or resource identification.
\nhttp://localhost:2053/randompath/panel/api/server/getNewUUIDThe response from this endpoint will be in JSON format and includes the following structure:
\nsuccess: (boolean) Indicates whether the request was successful.
\nmsg: (string) A message providing additional information about the request status.
\nobj: (object or null) Contains the UUID if the request was successful. The structure of the object is as follows:
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"uuid\": \"generated-uuid-value\"\n }\n}\n\nThis endpoint is essential for generating unique identifiers required for various operations within the application.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","getNewUUID"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"e9eca173-8945-4ca1-8ef3-6898f90c1de1","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewUUID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 23:17:30 GMT"},{"key":"Content-Length","value":"79"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"uuid\": \"0b8ca9c6-9f47-42d5-971f-af595efd842b\"\n }\n}"}],"_postman_id":"749ca293-1b74-4dca-bc0b-f9727f060369"},{"name":"get New X25519 Cert","id":"484d7d37-ff32-424d-b518-8b44d04d179f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewX25519Cert","description":"This endpoint retrieves a new X25519 certificate, which includes both a private key and a public key. This certificate is essential for secure communication and cryptographic operations.
\nhttp://localhost:2053/randompath/panel/api/server/getNewX25519CertThe response from this endpoint will be in JSON format and will contain the following fields:
\nsuccess (boolean): Indicates whether the request was successful.
\nmsg (string): A message providing additional information about the request status.
\nobj (object): Contains the certificate details:
\nprivateKey (string): The generated private key.
\npublicKey (string): The generated public key.
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"privateKey\": \"\",\n \"publicKey\": \"\"\n }\n}\n\nThis endpoint is expected to return a 200 HTTP status code upon successful execution.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","getNewX25519Cert"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"fd2365f4-ed87-41dd-bb5d-cb7a69966c36","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewX25519Cert"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 23:08:11 GMT"},{"key":"Content-Length","value":"150"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"privateKey\": \"aHa5WREV94uI9LYFFzxoBVjXnfTXVNpewvzIrkXtp3w\",\n \"publicKey\": \"3L7iv-NlexMtONKoHqnqTcirRoaVgb7dqvRbbtuOplM\"\n }\n}"}],"_postman_id":"484d7d37-ff32-424d-b518-8b44d04d179f"},{"name":"get New mldsa65","id":"f64c71ae-ae06-494a-bd2b-9512cdc1b487","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewmldsa65","description":"This endpoint retrieves the status of the server by making an HTTP GET request to http://localhost:2053/randompath/panel/api/server/getNewmldsa65. It is designed to provide information about the server's current state and performance metrics.
Method: GET
\nURL: http://localhost:2053/randompath/panel/api/server/getNewmldsa65
No request body is required for this endpoint.
\nThe response from this endpoint will be in JSON format and will contain the following structure:
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"seed\": \"\",\n \"verify\": \"\"\n }\n}\n\nsuccess: A boolean indicating whether the request was successful.
\nmsg: A string that may contain additional information or error messages.
\nobj: An object that may contain various properties depending on the server's status.
\nThis endpoint is useful for monitoring server health and performance metrics, providing essential data for system administrators and developers.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","getNewmldsa65"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d44aed18-f4fa-405e-9074-8c68fdf793bd","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewmldsa65"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 22:36:47 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"seed\": \"RG5tF_0mZMdGCniZyMfdF-TQCaIU-74qsiLxR_ls_IA\",\n \"verify\": \"XZKpy8CwZp2dYNBJUwIbG8I7RFOZUtpBCNdraVRTQY0GSHlMpcjDzjX_rSxKr8JBlohfablGY6LNsPtLBg19SZfGOlrkhJLLNv7SL7hXCwhOPvdXt-0R0sarO9AYUmHvMk4ClrCGBi4dP68fudsNbALuVlYFxcTSG68MWhSFJSYoaN4p-n2QYH1BwBsLcZy9H4uLsdGMDxevRiL13ujLphc1XfFvNIL2thT1BtCSjex7gBA1v-vKPU0_Djskm09PLJjPbv1ol40C6Q7p-tmg8hTGpP_8PPXJmVVimud53jjlkrB7EUgA-xgkrAgnfp-rfWc77LMHDn7_-QmS6Weu9GKzI0wIMJpcaRv-OBOfqaYw-kSA3jq1qhD0yDBflqZeWNc7b_XvWsxRio0CUKD8gPUlyG_ipuq5dzlfL3PGzGTCxDdtE9CLjiy2hA7k-dM6FhwFaFXDJH1zPGoz7sec3yTiacwfGEoa1vjT5k8xFuAqZ-xyHdqGQfu09LsBMWQ_O_a129tCHhV1oo9J5x9VKk_YM2i_VsK3sMM868_kBM3L0hVz34D2kSFSryjDTxc7lY0vY0SlANYoykKjhwtF8BC-GS61KSu-aXRyWfzcA9BlBXWoOSVEh47jzs1Z_8QcZvcBrYPZyq0oi--aKNYBi19FbvEqRkb92mX4G1kahXYluEy80uLkbA5jFsLKzdZEZ9EBUAmDW1Vti0LcKRoZpd-GE01bZacAr_gVShv-lKqhJTp8y8CZ3Ss5Q-Ct26tY8cnX3eTN1D9e-svfBLKqBIpeP0eJW0Bh4IuSz_r5t1HAzyqyigwX--u4vhGMiTq1kwXy_XcXaWNjnswcze-7oT6vHl7mFJ8Kv6OC_n9ukdR5qcFbckshoUzWGrmo5pIl2Q-1lFXO5rIcZQ7zFr1qdSKT-zPBj3UayrMc6GC5weOXDhg4IiyPUCvZ8ScB5UF6YepL3jsJ3mWG2IxO7SE7DONlS8vTffox6zPjxotzKNKudmH5fPxmmumRl-nQmYy-hyA5hvl8f2brRWxs_e8OOXIpHrrRtfAnVzbwTwfxbRT4tnCxxWiSD2R_uZ81j2LkP_SDS014i0dFBDRLiyQE4vkkaQlKAsn2ZDP9jQ1JlrwLUY_bGTrRhYG4bRBtSB6w3BYe3ttP0DlX5RY5nmOxHciHYUmkyhbYo7p7AiQURGEszDtWE4wK0FW83iQINlTqF1vW6WQJZXOwWQbKHT7iw29nsYtueyoc1FsAnfEAqoGIZda1Fy5CiaCoviUln6HjcF5_Pl-XXXljc0Viw0jR6YMnAiOkItaOGGMxWLuPpCZfV1NzASU7AiMpzFgbvM-3hNjkRXxxNr_GFjcg-kU4SX3oxRVWQlLZ6_2oyKXT0dOEymQdXS6qyQ4FGfEJytGZa-xbLBAwPcmaMEtAYeCww-1cpebQhfhAvuBEYn22NXrlOWy5g_gVuGyC9fr4a44hkrWjkq_nYA8thoycrzbrOXJDeWZk_ULF1_cnKm9FiS8dxZA74xgUXvZrB_oiHcujG22pZBFjq1qS_rAEGzt0fupgS0TFDSqIU3CDE35cHzJNg8FAMmOycSS2xR7Aah0B3-jIt9lRXm-ci9717eIPqTIlhwX_IVgQgOVSv3rqSfMdHbJ75yajVc05qjJvjNk2sZbL9Dt3O9Ydm6_4x7HBxQOXYma23hyTBp5pphF1WEKUTlalNUkCa2JtwPoWOSsG3fmhxyz_zLQb2ig6YgweNzsH1mlr1OQquPPG7yEdxgNyyVu-WXLdsiiiNfuSL3I12nblBFOpCok900-Vbb9_sQGZy5GT1FqkM22QdqREAcOvk7_PO_c3RNZRreO7rejOkuWAQukvaZUEdmAtjonCz_n50cTQPIrjwKBeyaIlwOif4sukyxJeYRVEPnBalr9OU6neaN-WJr4IScXhRgln-A4CgNxP7Fj25CsdxO_bU4Hu0LSsvTNzQpPQhR3NzkZ5v6clLbx8trUm1WspU6cJ8xuWk7aTqbCpTr-iwns4bZVeaUSy0M9dqh7fyoYH5SeXEInS-c32Ksby6hsQa4VJGLv_-xg6FIFcDU-Fx4QAmFix4Y6VL9SDQW5tcDnleFY_wewXgekorA0WVbklOjw1rBwOAgecXXA50ZNpv_-4heoVrhi80yb1u1h2mbBhod32sZXjegpXBSdHOvzfuuK49u0yX75IL6vs9uiRUozYttpKQlUc2Uqup5TeW_kYy7YrFAorDSpp7eLgJiOkrQYDfBw9bjHjqtJrW1HE0QwgXukWY8Dn5p8UgA4XxFaQLnhbJyyESReVRrsFaj1APg3XkPN-BlxPCVc5G6nmz6nq_b4z7hn6vmHjtyWuR14QML3k7ArNkdSTQp1Yg_85vnE4GnUKdinWYyWdTJEs7Eh0NvNW-KiDqbvjN1mk50TJnoMaorKbhIr6CbKlvL5waRJC8wCOAW9Pp33BCiG0GrBShvJkNCYUhl_aQWLAJStwJI9C9BhNhmWTvoxf_16v06jBOVJ-jPt9rbwKuZtHpkAUPesZNr4CrzxcnIq6oKnGIDzbJIjKE-JJas0XwIwRoypOMRdkUqf_dhbkapxfj6P2iEA\"\n }\n}"}],"_postman_id":"f64c71ae-ae06-494a-bd2b-9512cdc1b487"},{"name":"get New mlkem768","id":"67ef25cf-f636-45be-9e9e-7fd014e071d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewmlkem768","description":"This endpoint retrieves the status and configuration details of the server associated with the specified identifier. It is particularly useful for monitoring server performance and obtaining essential metrics.
\nMethod: GET
\nURL: http://localhost:2053/randompath/panel/api/server/getNewmlkem768
This request fetches the current status of the server, including various performance metrics such as CPU usage, memory usage, and network statistics. It is essential for administrators to monitor server health and performance in real-time.
\nEnsure that the server is running and accessible before making the request.
\nThe response may vary based on the server state and configuration.
\nThis endpoint is integral for obtaining real-time data about the server's performance, allowing for effective monitoring and management.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","getNewmlkem768"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"1a85be9a-7b35-4712-9fbf-ce6d19438f40","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewmlkem768"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 23:10:50 GMT"},{"key":"Content-Length","value":"1720"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"client\": \"dpxpe7U-UNeHgHmf57JGmcrLgTyOFdefywxds_xIPOJAQ2gztXgxWJebtvNJgCQ3jOGuD0FHUQJBNvEs13FBbAw8-MlgIXWQrgQqoOJPjahc6BUNyIpj_5NCOLKlLTui6yK4uWRvxoOoBSshkYGVwXAiRqoF8jW9vDl1DIuAnlQPHTOnrRCRHkSWewQF9NM1ntFdr-sPOpENT4UrNjRB1dfB1FUxu1iDnYUQFMgFP4jJ4CYbpaCqhbgV4KTHSVrF69uN2oxMyLCDLHKfJqNwgGIjJZhQ9vYk0qPBRaHBSVsphtpQIyM-7mEw7HZ9CTJdkjqQFLuHPWJhrreijLCKD-seURYFxEDOS-qYTshvT3RnOigb-WqZ38hxDZF1YDgWF3pjW0U6o3qAfydLdzfACLixR9JpONEyCpuRTfK9RbzA5ZZ_kKBRtMlBk_OhBjFe9uM8UMVNyuRqrMi9ZRIjluhuYitW6-cOrklLPUzAu2Cogrk0VEUntoxdJci0B0TDIbBZFSgJXPwDLjqmgfNFVeUbo2zAG4B0w7ax-yCarkk4KLU9QpGQpug0YsykrHRnL7KYWeirD4NIZvhVFzPE0lzGq-rDyEVNanaBg6ZzeSVB_PF8u2TDuecNINGjvBKWwpF3C3a4p2ot1XjE0XFPgCCXiNgZnpxxhTptifoDdpeISRmwYFcZrMe9ktJpRWUThkIphjB9cBIHg9Cd6Fa5-kSw06NehjF4McG7jLenMsiOqlqK0hNek_QPnLBUqcWYvgFYmXmXonW_wVELQPEl3ucb11OhK2NTp3s08wtSK5RyXbQSdApt-_pTbfEMLBYOq2mZxTkzbVKeRpVOFxfOlCd8cMuLBtOApGtsX8VwFzlPhcCm8PQ46tY1VBJOlkEMoThMZNagz9AfulqF0WS9FLwS1ABF9Vt0PSJDnTa17_QrZYAEbzPIo2EbXmMhp_ltxUZUtqapLfSCAFdi2LUTq_sxLRQLNNZYAqVUXwGq0FQkIuJQDeA2zayLHMYM5bgSqUdJklIqcPobyLkDOMSk9TktYXCnVBIn4lMdaBcZUouEpUgrKDmeQRG8BlULbNIynvyRgHXH13gYP0PO7We0QTWSDDVY3-zH8IUrXKcbeLLB1nhzzglqKphtNXaE5IVW3kNsOxfEHvoxndE1SokMjOwWYsw4faCxNoY5e2RRhXF0MhKNCRALX5TO8oiJAtISNkix_shIoXpkjYtF3zs9oLlf-kuCG3ZVPLC3EEdq6YMjFTkHztGUZlpj9vJ2DxtT9NWiwdWPeuRk5Phd2CUoO3AVwonI4Iwtd3ZDz3mDQlOIw6q-KLhfQctW_Lx4K-I-aTAHZ2KDxMudw9aI2XqyQwKhfPEfc1xZ-pOAVOgzgkceI6ySP2IBzBy09ZESVGcSEZgPFXVBSgeOBbq4lbLN6RdD2Bk_LUJZY_KcFgIOKVMwykUBkDlonqZsavEpEFRVvoXAujRsMeFmN6gJxSpxKaMWqtrPihcSNyOhhEmiEUc4tLMLvYdkyglxD9AWI0gWD0YNr1zLsIx1TK25PmDZiL7V_nvl53WVwi3ukRf8w-c\",\n \"seed\": \"VzJj9F1rvKXVDTJwyvmCvTKYX9ABiydklvOESw_OQQsl3hMpOVFOBp7v_-s8DWYNG9gFVHiOJ1KXw5yvoFIw2w\"\n }\n}"}],"_postman_id":"67ef25cf-f636-45be-9e9e-7fd014e071d3"},{"name":"get New Vless Enc","id":"b7f5378e-ab7c-428d-849d-7fa37bf70487","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewVlessEnc","description":"This endpoint retrieves the current configuration for the VLESS encryption method used by the server. It is designed to provide information about the available authentication methods, including their decryption and encryption settings.
\nThe response will return a JSON object containing the following structure:
\nsuccess: A boolean indicating whether the request was successful.
\nmsg: A string that may contain additional information or error messages (if applicable).
\nobj: An object containing an array of authentication methods. Each authentication method includes:
\ndecryption: A string representing the decryption method.
\nencryption: A string representing the encryption method.
\nlabel: A string that serves as a label for the authentication method.
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"auths\": [\n {\n \"decryption\": \"\",\n \"encryption\": \"\",\n \"label\": \"\"\n }\n ]\n }\n}\n\nResponses from other endpoints in this API may return similar structures, often with a success field and an obj that can be either an object, array, or null, depending on the specific endpoint being called.
This endpoint retrieves the latest VLESS encryption configurations from the server. It is primarily used to obtain the current encryption settings that can be utilized for secure communication.
\nMethod: GET
\nURL: http://localhost:2053/randompath/panel/api/server/getNewVlessEnc
The response from this endpoint is in JSON format and includes the following fields:
\nsuccess (boolean): Indicates whether the request was successful.
\nmsg (string): A message providing additional information about the request's outcome.
\nobj (object): Contains the details of the VLESS encryption configurations. This field can have the following structure:
\nauths (array): An array of authentication objects, each containing:
\ndecryption (string): The decryption method used.
\nencryption (string): The encryption method used.
\nlabel (string): A label associated with the authentication method.
\nA successful response may look like this:
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"auths\": [\n {\n \"decryption\": \"\",\n \"encryption\": \"\",\n \"label\": \"\"\n }\n ]\n }\n}\n\nResponses from other endpoints in this API may return similar structures, often with a success field indicating the result of the request and an obj field that can either contain relevant data or be null.
This endpoint is critical for applications that rely on VLESS for secure data transmission, ensuring that the latest encryption methods are always in use.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","getNewVlessEnc"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"bafc4529-3f86-4f71-a020-1f1509c5c41f","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewVlessEnc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 08 Sep 2025 23:16:52 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": {\n \"auths\": [\n {\n \"decryption\": \"mlkem768x25519plus.native.600s.YFTcWrEulaPORRccLD0QH95NOCo4hlUzaGPq_5mMmEk\",\n \"encryption\": \"mlkem768x25519plus.native.0rtt.5gdj5V4eNShGBvaWOLX3RtokDD0uSy9LtcvDfvPN1HU\",\n \"label\": \"X25519, not Post-Quantum\"\n },\n {\n \"decryption\": \"mlkem768x25519plus.native.600s.PrL1bfe6dgdksMT3E5oAEr-la6h7KZTqu9679F-inkbcSSCkwmExCONLvfgkDvuMSFluuPj0hJNKeVuzfckyEA\",\n \"encryption\": \"mlkem768x25519plus.native.0rtt.N-gYHVAmMTQskecls5vJJ2TBMqp0mmKuM8S5WDqbdUCbSQwwcQwf1TMHq8t2aoc2O1opo-hyzCMV5ycf_bSXAmxK3vionBVIAuV6alLH44iM1XGDfYdJcVBgcbNqCDJJaLZKQAh4obyASbqi02ZqcnBLwYwV1qK0GlJ1-rJGI6yU_nkaKxxJf8wwsoc_WvluBzapiqoAaqCOkQRy8DUi_FO9HPGC32yVRGgEdynJt1HGsTAC_XTJhXEYyZc8ORhWQpdKEYk3LSp0wgcGJFm9uDFDR3JyM_SH2zeWQyuEZpNgkeUkyeGmr2asb-hU8btzqVtKjvoZTCAQfAiTFmkLittsXhZNPmZO49W3ozcm9KFB0sPHj-AjKDjIT6EB7ForHxWq59VMOvMPCNUefeC_WaPFgGaClsVVrugm6DVXnQqL-FnELGesJDkLWAuLGdIo_scfzapAEhBqaTO-0FF6PgOpfaqsdNggPZdDNBlqAdhxrCMxh_d1wfpSB6OhUjs1jTe363BiqNF3rhq5LmlcGMMZZ7N46jgVsDa8N7hRxUkJ8jp2bjQGg9W4aQae45AWuqQ7_FLNP_u3jNTMY6nMpalOM9JRqbmVU_OynNwla-IBjkalsonH_Jy3sHCofJe4nAl5PecjmTa2kjInLaNu07hoAnNVQvoD9BJIoXzNcvWZqNeTrfE2Awkm4cZ1UCCh58wjQ1NPiACZMtGII5hUlcCnPcMCJoO_S6Q1vlmfJcZ4fxyQzot1wWGI09K66SoBh9Riz5oSOYy-OKfMpPyxJZM4CvauxbsWE8oYJ5U0axuN_vxP_XcTDyHCe4B4qnmRnAUO7cZ0v7VM8jUUM1FMeqFcoARv1yFxBPsb9TFSNOhIGCIdSpdZ1tg4VmwDX-VSASuwUTQ6l8YQ60YXNNvHBoEuyahhjeleWTHN_fBKTVysElzGHrmzZEfLBDOrqRmlG_WEBVcynKelQ5Odf0BeG9BotlRyKfc_dTwHWQEQYiAxVcwHkXMv3TG4xlezG4Uw0HHHF3tvt1umwoIWNzGc7EpM73dohkc-4yiZGcxcgBmvjwKvt2daPvIHKGCLTbOKyKqicCJqNAheZYtIctoVfOaq3AYHfIxaFlHMKrxxDuFXi-Fw-rILtMshOvutrHm9_EzDp0xwBQNKKNVxHfBf16FU3ny54fu95CjLhHGUvDgSucwqZJkgmHyyXmwiRNGSGqnKTDaEd3ts5GiQope7jbNIDdYW-AcYfrwq7WUy9rhOMHuDNDgcp6s2ZWU6IpkDQ8diFAw9ozRsauGJ3eWiFRkjZfYU6LIatkVbEpG_IgcPzUeOGBjKYZqiniisuQtjTHOy0oMCFjp8qrvP00dFdsJzkgeGiidx-TcHjoc_I-gSDaUpGekeAIROlkJOmSsO6RgfhKJlWySx02CwbPlTXiQOVvUDwwMiqGMZOHATAmkmHOdg6viuW1lbWYlsa9iAU9ETUycJe9in1EOtCkgTr8kCRJx1Jhij9jiPltKCovmOpUW01aenqMloTsUrK1NHCW-RoCUKkMJxSWLgrg3kLKe2Uz5lCwiODk-24phElXQ\",\n \"label\": \"ML-KEM-768, Post-Quantum\"\n }\n ]\n }\n}"}],"_postman_id":"b7f5378e-ab7c-428d-849d-7fa37bf70487"},{"name":"stop Xray Service","id":"c61a8905-8cbe-4f9d-8148-e4b53bbb2668","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/server/stopXrayService","description":"This endpoint is used to stop the Xray service on the server. It is a POST request that does not require any body parameters.
\nMethod: POST
\nURL: http://localhost:2053/randompath/panel/api/server/stopXrayService
Upon a successful request, the API will return a JSON object with the following structure:
\nsuccess: A boolean indicating the success of the operation.
\nmsg: A message string that may contain additional information about the operation.
\nobj: This can be null or may contain other relevant data based on the context of the request.
{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": null\n}\n\nThe response will always return a 200 status code indicating that the request was processed successfully.
\nSimilar endpoints return responses with the same structure, which may include more detailed information about the server's state or statistics.
\nEnsure that you have the necessary permissions to stop the Xray service before making this request.
\nThis endpoint is used to restart the Xray service on the server. It is a crucial operation that may be required for maintenance or troubleshooting purposes.
\nMethod: POST
\nURL: http://localhost:2053/randompath/panel/api/server/restartXrayService
Request Body: The request does not require any specific parameters in the body.
\nThe endpoint is expected to return a 200 status code for successful operations.
Ensure that the Xray service is not already running before sending this request to avoid unnecessary restarts.
\nMonitor the response for any error messages that may indicate issues with the restart process.
\nThis endpoint is used to install Xray on the server. It accepts a version parameter in the URL path to specify the version of Xray to be installed.
\nThe endpoint will return a 200 OK status code on successful installation, along with the response structure outlined above.
Ensure that the correct version parameter is provided to avoid any installation issues.
\nThis endpoint is used to update the geofile on the server. It processes the provided data and returns the status of the update operation.
\nMethod: POST
\nURL: http://localhost:2053/randompath/panel/api/server/updateGeofile
This endpoint allows you to update a geofile on the server by providing a specific filename. It is a POST request that targets the URL http://localhost:2053/randompath/panel/api/server/updateGeofile/{fileName}, where {fileName} should be replaced with the actual name of the file you wish to update.
This endpoint is crucial for maintaining and updating geofile data on the server, ensuring that the latest information is available for processing and analysis.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","updateGeofile","geosite.dat"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a4ad8998-6f43-417a-97f8-b8d405b4d7ea","name":"success","originalRequest":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/server/updateGeofile/geosite.dat"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Sep 2025 10:54:29 GMT"},{"key":"Content-Length","value":"64"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"Geofile updated successfully\",\n \"obj\": null\n}"}],"_postman_id":"7323bef8-a022-4a20-aba3-769dcac5a13f"},{"name":"logs/{count}","id":"2a11f57a-15dc-4766-8e90-c47cc3e213bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"level","value":"debug","type":"text","uuid":"23fd920d-da26-4d0a-93a9-79f0b01f920f"},{"key":"syslog","value":"false","type":"text","uuid":"62d2e1ee-25b7-495b-8891-779d32ca48ef"}]},"url":"http://localhost:2053/randompath/panel/api/server/logs/{count}","description":"This endpoint allows you to log server events by sending a POST request. It accepts specific parameters related to the log level and the syslog message.
\nPOST
\nhttp://localhost:2053/randompath/panel/api/server/logs/logs/{count}\n\nThe request body should be sent as form-data with the following parameters:
level (type: text): Specifies the severity level of the log (e.g., INFO, ERROR, WARN).
\nsyslog (type: text): Contains the actual log message to be recorded.
\nUpon a successful request, the server will return a JSON response with the following structure:
\n{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\"\"]\n}\n\nsuccess (boolean): Indicates if the logging was successful.
\nmsg (string): A message providing additional information about the request (usually empty).
\nobj (array): An array that may contain additional data related to the log operation. It can be an empty array or null.
The endpoint is designed to handle logging operations efficiently, ensuring that server events are recorded correctly.
\nThe response will always return a status code of 200 for successful operations, regardless of the content of the obj field.
Similar endpoints may return responses with similar structures, providing a consistent API experience.
\nEnsure to replace localhost, 2053, and /randompath with the appropriate values when making requests.
This endpoint is designed to retrieve X-ray logs from the server. It allows users to specify the number of log entries to be returned through the {count} parameter in the URL. This is essential for monitoring the server's performance and for analyzing log data.
Method: POST
\nURL: http://localhost:2053/randompath/panel/api/server/xraylogs/{count}
Path Parameter:
\n{count} (integer): Specifies the number of X-ray log entries to retrieve.Request Body (form-data):
\nshowDirect (string): Indicates whether to show direct logs.
showBlocked (string): Indicates whether to show blocked logs.
showProxy (string): Indicates whether to show proxy logs.
The response will contain a JSON object with the following structure:
\nsuccess (boolean): Indicates whether the request was successful.
msg (string): A message providing additional information about the request.
obj (array or null): An array of log entries or null if no logs are available. Each log entry will contain:
DateTime (string): The date and time of the log entry.
FromAddress (string): The address from which the log originated.
ToAddress (string): The address to which the log was sent.
Inbound (string): Indicates if the log entry is inbound.
Outbound (string): Indicates if the log entry is outbound.
Email (string): The email associated with the log entry.
Event (integer): The type of event logged.
This endpoint is crucial for monitoring the server's performance and retrieving logs for analysis.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","xraylogs","20"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"af3fb9c1-3ddc-420d-abde-6b8cf59e143b","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"showDirect","value":"true","type":"text","uuid":"3f216cb4-1559-4425-bad3-f13fe0048727"},{"key":"showBlocked","value":"true","type":"text","uuid":"034393f1-61fd-4dbe-a82a-74e35e0d96d7"},{"key":"showProxy","value":"true","type":"text","uuid":"9384c0ee-1d94-447e-a2ef-b59168912093"}]},"url":"http://localhost:2053/randompath/panel/api/server/xraylogs/20"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 25 Sep 2025 10:48:55 GMT"},{"key":"Content-Length","value":"413"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"msg\": \"\",\n \"obj\": [\n {\n \"DateTime\": \"2025-09-25T12:48:39.549806Z\",\n \"FromAddress\": \"tcp:[::1]:59472\",\n \"ToAddress\": \"tcp:www.google.com:443\",\n \"Inbound\": \"inbound-58367\",\n \"Outbound\": \"direct\",\n \"Email\": \"ce0wa59b\",\n \"Event\": 0\n },\n {\n \"DateTime\": \"2025-09-25T12:48:39.870332Z\",\n \"FromAddress\": \"tcp:[::1]:59472\",\n \"ToAddress\": \"tcp:speed.cloudflare.com:443\",\n \"Inbound\": \"inbound-58367\",\n \"Outbound\": \"direct\",\n \"Email\": \"ce0wa59b\",\n \"Event\": 0\n }\n ]\n}"}],"_postman_id":"391b82b4-f7cb-49a3-982a-f3463c2ed379"},{"name":"importDB","id":"492f8442-cb5d-4417-a8a9-58e6e0cd8404","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/server/importDB","description":"Endpoint: POST http://localhost:2053/randompath/panel/api/server/importDB
This endpoint is used to import a database into the server. Upon a successful request, it returns a JSON response indicating the success of the operation along with relevant server statistics.
\nThis endpoint is crucial for managing database imports and monitoring server performance.
\n","urlObject":{"protocol":"http","port":"2053/randompath","path":["panel","api","server","importDB"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"492f8442-cb5d-4417-a8a9-58e6e0cd8404"},{"name":"get New Ech Cert","id":"427c7889-b678-4dcc-8f0c-4c4f45663af0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:2053/randompath/panel/api/server/getNewEchCert","description":"This endpoint allows clients to retrieve new Echo certificates from the server. It is accessed via an HTTP POST request to http://localhost:2053/randompath/panel/api/server/getNewEchCert.
This endpoint does not require any specific parameters in the request body. It is a straightforward call to fetch new Echo certificates.
\nUpon a successful request, the server responds with a JSON object that includes the following structure:
\nsuccess (boolean): Indicates whether the request was successful.
\nmsg (string): A message providing additional information about the request status.
\nobj (object): Contains the following fields:
\nechConfigList (string): A list of Echo configuration settings.
\nechServerKeys (string): The server keys associated with the Echo certificates.
\n{ \"success\": true, \"msg\": \"\", \"obj\": { \"echConfigList\": \"\", \"echServerKeys\": \"\" }}
\n{ \"success\": true, \"msg\": \"\", \"obj\": null}
\nThe endpoint returns a 200 status code for successful requests.
\nSimilar endpoints may return responses with different structures, but they generally follow the same success message format.
\nEnsure that your application handles both successful and null object responses appropriately.
\nThis documentation should help users understand how to interact with the getNewEchCert endpoint effectively.