The Shiftproxy API provides end-users and resellers an easy way to CRUD data from our servers.
This documentation is intended mostly for reseller users, though end-users may interact with the permitted API endpoints.
For any inquiries, please email admin@shiftproxy.io
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15802175","collectionId":"1d339776-00ff-4c70-b4d4-ccd660b1f088","publishedId":"UzR1JMzP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-07-20T23:30:56.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","id":"4322271c-aef8-417f-89c4-3ac8c89e6119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"resellerName","type":"text"},{"key":"password","value":"resellerPassword","type":"text"}]},"url":"http://URL:PORT/api/login","urlObject":{"path":["api","login"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"6c1e756a-e7e1-497a-8f7b-7494a7f1321a","name":"Login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"myuser1","type":"text"},{"key":"password","value":"mypass1","type":"text"}]},"url":"http://URL:PORT/api/login"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"token\": \"TOKEN\"\n}"}],"_postman_id":"4322271c-aef8-417f-89c4-3ac8c89e6119"}],"id":"a48921fe-4e36-45a2-be64-c8472c7be156","description":"Authentication is strictly intended for reseller users.
\nThe resultant XSRF-TOKEN is valid for up to 24 hours.
\n","_postman_id":"a48921fe-4e36-45a2-be64-c8472c7be156"},{"name":"User","item":[{"name":"Add","id":"b29b16d3-f345-45fb-b517-e81da52cea20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"endUsername\",\n \"password\":\"endPassword\",\n \"concurrencyCount\":100,\n \"email\":\"myenduser@email.com\",\n \"expireDate\":\"2022-11-08T23:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/user/add","urlObject":{"path":["token","api","v1","user","add"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"b616f0a4-c98d-498a-99f7-5c97de5023e0","name":"Add","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"myenduser2\",\n \"password\":\"myendpass2\",\n \"concurrencyCount\":100,\n \"email\":\"myenduser@email.com\",\n \"expireDate\":\"2022-11-08T23:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/user/add"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"reseller\": \"datacenter\",\n \"name\": \"myenduser2\",\n \"email\": \"myenduser@email.com\",\n \"expireDate\": \"2022-11-08T23:00:00Z\",\n \"password\": \"myendpass2\",\n \"concurrencyCount\": 100,\n \"created_at\": \"2022-07-20T13:39:49.096810104-07:00\",\n },\n}"}],"_postman_id":"b29b16d3-f345-45fb-b517-e81da52cea20"},{"name":"Delete","id":"3434347a-4328-4ba1-8eaf-ec5f7c824fb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"url":"http://URL:PORT/token/api/v1/user/del/endUsername/resellerName","urlObject":{"path":["token","api","v1","user","del","endUsername","resellerName"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"8eaa9d28-3eda-4972-b71a-6b79d481d69f","name":"Delete","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"url":"http://URL:PORT/token/api/v1/user/del/myenduser1/datacenter"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": \"success\",\n \"msg\": \"\"\n}"}],"_postman_id":"3434347a-4328-4ba1-8eaf-ec5f7c824fb7"},{"name":"Edit","id":"3832c009-e059-41ce-b821-b796df27b7db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reseller\": \"resellerName\",\n \"name\": \"endUsername\",\n \"email\": \"newenduser@email.com\",\n \"expireDate\": \"2022-11-16T23:00:00.000Z\",\n \"password\": \"endPassword\",\n \"traffic\": {\n \"ByteIn\": 0,\n \"LockByteIn\": {},\n \"ByteOut\": 0,\n \"LockByteOut\": {},\n \"TrafficLastUpdateAt\": \"0001-01-01T00:00:00Z\",\n \"Status\": \"Pending\",\n \"PendingAt\": \"0001-01-01T00:00:00Z\",\n \"CurrentStartedAt\": \"2022-07-20T20:53:21.062Z\"\n },\n \"concurrencyCount\": 300,\n \"transferLimit\": 0,\n \"userPlanId\": \"\",\n \"created_at\": \"2022-07-20T20:53:21.062Z\",\n \"current_conn\": 0,\n \"speed_kbps\": 0,\n \"PlanExpireDate\": null,\n \"trafficTotal\": null,\n \"status\": \"Pending\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/user/edit","urlObject":{"path":["token","api","v1","user","edit"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"12c68a93-a9e3-4cbe-a098-c4cb52a7a041","name":"Edit","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reseller\": \"datacenter\",\n \"name\": \"myenduser1\",\n \"email\": \"newenduser@email.com\",\n \"expireDate\": \"2022-11-16T23:00:00.000Z\",\n \"password\": \"myendpass1\",\n \"traffic\": {\n \"ByteIn\": 0,\n \"LockByteIn\": {},\n \"ByteOut\": 0,\n \"LockByteOut\": {},\n \"TrafficLastUpdateAt\": \"0001-01-01T00:00:00Z\",\n \"Status\": \"Pending\",\n \"PendingAt\": \"0001-01-01T00:00:00Z\",\n \"CurrentStartedAt\": \"2022-07-20T20:53:21.062Z\"\n },\n \"concurrencyCount\": 300,\n \"transferLimit\": 0,\n \"userPlanId\": \"\",\n \"created_at\": \"2022-07-20T20:53:21.062Z\",\n \"current_conn\": 0,\n \"speed_kbps\": 0,\n \"PlanExpireDate\": null,\n \"trafficTotal\": null,\n \"status\": \"Pending\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/user/edit"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": \"success\",\n \"msg\": \"\"\n}"}],"_postman_id":"3832c009-e059-41ce-b821-b796df27b7db"},{"name":"Query","id":"7e02ba1f-709e-463c-8638-1863d03e9c1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"endUsername\",\n \"reseller\": \"resellerName\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/user/query","urlObject":{"path":["token","api","v1","user","query"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"066303f3-133f-47a8-9099-fd7ac6a46719","name":"Query","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"myenduser1\",\n \"reseller\": \"datacenter\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/user/query"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"users\": [\n {\n \"reseller\": \"datacenter\",\n \"name\": \"myenduser1\",\n \"email\": \"test@test.com\",\n \"expireDate\": null,\n \"ipWhiteList\": \"\",\n \"password\": \"myendpass1\",\n \"traffic\": {\n \"ByteIn\": 2888444,\n \"LockByteIn\": {},\n \"ByteOut\": 12553878,\n \"LockByteOut\": {},\n \"TrafficLastUpdateAt\": \"0001-01-01T00:00:00Z\",\n \"Status\": \"Active\",\n \"PendingAt\": \"2022-07-31T14:54:28.079Z\",\n \"CurrentStartedAt\": \"2022-07-21T19:04:37.03Z\"\n },\n \"concurrencyCount\": 0,\n \"transferLimit\": 1000000000000,\n \"userPlanId\": \"306c4a3db5f56f76aa4a\",\n \"created_at\": \"2022-07-21T19:04:37.03Z\",\n \"current_conn\": 0,\n \"speed_kbps\": 0,\n \"PlanExpireDate\": null\n }\n ],\n \"super_port\": \":4000\",\n \"super_port_host\": \"\",\n \"total\": 1\n },\n \"msg\": \"\"\n}"}],"_postman_id":"7e02ba1f-709e-463c-8638-1863d03e9c1a"},{"name":"Info","id":"02211cab-de77-4d7f-9390-c951c09abec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://URL:PORT/api/v1/user/info/endUsername/resellerName","urlObject":{"path":["api","v1","user","info","endUsername","resellerName"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"6fd4ab5f-1bc0-4516-8d88-538c75b4f12d","name":"Info","originalRequest":{"method":"GET","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text","disabled":true}],"url":"http://URL:PORT/api/v1/user/info/myenduser1/datacenter"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"user\": {\n \"reseller\": \"datacenter\",\n \"name\": \"myenduser1\",\n \"email\": \"\",\n \"expireDate\": null,\n \"password\": \"\",\n \"traffic\": {\n \"ByteIn\": 0,\n \"LockByteIn\": {},\n \"ByteOut\": 0,\n \"LockByteOut\": {},\n \"TrafficLastUpdateAt\": \"0001-01-01T00:00:00Z\",\n \"Status\": \"\",\n \"PendingAt\": \"0001-01-01T00:00:00Z\",\n \"CurrentStartedAt\": \"0001-01-01T00:00:00Z\"\n },\n \"concurrencyCount\": 0,\n \"transferLimit\": 0,\n \"userPlanId\": \"\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"current_conn\": 0,\n \"speed_kbps\": 0,\n \"PlanExpireDate\": null\n }\n }\n}"}],"_postman_id":"02211cab-de77-4d7f-9390-c951c09abec2"}],"id":"023fb6da-cec0-4b71-9221-14dae07ddff4","_postman_id":"023fb6da-cec0-4b71-9221-14dae07ddff4","description":""},{"name":"User Plan","item":[{"name":"Add","id":"f6f28053-bd19-4e70-b8d8-53029d878804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"endUsername\",\n \"reseller\": \"resellerName\",\n \"transferLimit\": 100000000,\n \"expireDate\": \"2022-07-24T22:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/userPlan/add","urlObject":{"path":["token","api","v1","userPlan","add"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"ad830d98-2005-4749-a120-296606caaf42","name":"Add","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"myenduser1\",\n \"reseller\": \"datacenter\",\n \"transferLimit\": 100000000,\n \"expireDate\": \"2022-07-24T22:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/userPlan/add"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"plan_id\": \"39463d78fb98eb944820\"\n },\n \"msg\": \"\"\n}"}],"_postman_id":"f6f28053-bd19-4e70-b8d8-53029d878804"},{"name":"Delete","id":"f2809032-e850-49c9-b91d-2f3146a371dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"url":"http://URL:PORT/token/api/v1/userPlan/del/planID","urlObject":{"path":["token","api","v1","userPlan","del","planID"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"d2d39d0c-1725-43a6-8787-b1baada90bf0","name":"Delete","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"url":"http://URL:PORT/token/api/v1/userPlan/del/39463d78fb98eb944820"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": \"success\",\n \"msg\": \"\"\n}"}],"_postman_id":"f2809032-e850-49c9-b91d-2f3146a371dd"},{"name":"Edit","id":"f7918630-3622-41ea-8b05-f7cc18522d02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"planId\": \"planID\",\n \"name\": \"endUsername\",\n \"reseller\": \"resellerName\",\n \"transferLimit\": 1000000000,\n \"expireDate\": \"2022-07-24T22:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/userPlan/edit","urlObject":{"path":["token","api","v1","userPlan","edit"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"c27fa963-03a9-4655-88cd-b4274ba44f77","name":"Edit","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"planId\": \"0f7ecfdf674f08d7f74f\",\n \"name\": \"myenduser1\",\n \"reseller\": \"datacenter\",\n \"transferLimit\": 1000000000,\n \"expireDate\": \"2022-07-24T22:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"http://URL:PORT/token/api/v1/userPlan/edit"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": \"success\",\n \"msg\": \"\"\n}"}],"_postman_id":"f7918630-3622-41ea-8b05-f7cc18522d02"},{"name":"Query","id":"905b6496-11b5-44aa-a67e-ebc649e07bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"url":"http://URL:PORT/token/api/v1/userPlan/query/endUsername/resellerName","urlObject":{"path":["token","api","v1","userPlan","query","endUsername","resellerName"],"host":["http://URL:PORT"],"query":[],"variable":[]}},"response":[{"id":"5688bd7d-874a-4358-92fd-b3997bc3eed3","name":"Query","originalRequest":{"method":"POST","header":[{"key":"XSRF-TOKEN","value":"TOKEN","type":"text"}],"url":"http://URL:PORT/token/api/v1/userPlan/query/myenduser1/datacenter"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"userPlans\": [\n {\n \"planId\": \"0f7ecfdf674f08d7f74f\",\n \"name\": \"myenduser1\",\n \"reseller\": \"datacenter\",\n \"status\": \"Active\",\n \"transferLimit\": 2000000000,\n \"createdAt\": \"2022-07-20T22:47:18.946Z\",\n \"expireDate\": \"2022-07-24T22:00:00Z\"\n }\n ],\n \"total\": 1,\n \"used_traffic\": 0,\n \"used_traffic_string\": \"0 B\"\n }\n}"}],"_postman_id":"905b6496-11b5-44aa-a67e-ebc649e07bae"}],"id":"da29f56e-b618-4cba-82bd-2651f5194370","_postman_id":"da29f56e-b618-4cba-82bd-2651f5194370","description":""}],"event":[{"listen":"prerequest","script":{"id":"9d1285f3-3608-4dac-a3b0-9cba726a81e5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bcbf4a89-c850-462f-811b-2603090b6733","type":"text/javascript","exec":[""]}}],"variable":[{"key":"resellerName","value":"resellerName","type":"string"},{"key":"resellerPassword","value":"resellerPassword","type":"string"},{"key":"XSRF-TOKEN","value":"TOKEN","type":"string"},{"key":"username","value":"endUsername","type":"string"},{"key":"password","value":"endPassword","type":"string"},{"key":"planID","value":"planID","type":"string"},{"key":"baseUrl","value":"http://URL:PORT","type":"string"}]}