{"id":1499,"date":"2021-02-18T17:55:43","date_gmt":"2021-02-18T17:55:43","guid":{"rendered":"https:\/\/help.getfoxyproxy.org\/?post_type=ht_kb&#038;p=1499"},"modified":"2021-02-18T17:58:17","modified_gmt":"2021-02-18T17:58:17","slug":"getting-server-list-and-accounts-programmatically","status":"publish","type":"ht_kb","link":"https:\/\/help.getfoxyproxy.com\/index.php\/knowledge-base\/getting-server-list-and-accounts-programmatically\/","title":{"rendered":"Getting Server List and Accounts Programmatically"},"content":{"rendered":"\n<h3><strong>Sending the Request<\/strong><\/h3>\n\n\n\n<p>To retrieve a list of all server and accounts registered to your email address or username, send an <strong>HTTPS POST<\/strong> to <span class=\"has-inline-color has-vivid-cyan-blue-color\">https:\/\/getfoxyproxy.org\/webservices\/get-accounts.php<\/span><\/p>\n\n\n\n<p><strong>Curl example<\/strong><\/p>\n\n\n\n<p><code>curl --header \"Content-Type: application\/json\" --request POST --data '{\"<strong>username<\/strong>\":\"AAAAA\",\"<strong>password<\/strong>\":\"BBBBB\"}' https:\/\/getfoxyproxy.org\/webservices\/get-accounts.php<\/code><\/p>\n\n\n\n<p>Note that HTTPS is required.<\/p>\n\n\n\n<p><strong>username<\/strong> is either:<\/p>\n\n\n\n<ul><li>One of the <strong>email addresses <\/strong>under which you are registered<\/li><li>One of the usernames under which you are registered<\/li><\/ul>\n\n\n\n<p><strong>password<\/strong> is the password associated with <strong>username<\/strong>. If you have more than one username, be sure to use the correct password.<\/p>\n\n\n\n<h3>Parsing the Response<\/h3>\n\n\n\n<p>A successful response has an HTTP status code of 200. The body is a JSON array. Each element in the array has the following properties:<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><tbody><tr><td><strong>Property<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Always Present in Response?<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td>active<\/td><td>string of &#8220;<strong>true<\/strong>&#8221; or &#8220;<strong>false<\/strong>&#8220;<\/td><td>yes<\/td><td>stringified boolean. if &#8220;true&#8221; then this account can be used. If &#8220;false&#8221;, the account is inactive and should not be used.<\/td><\/tr><tr><td>city<\/td><td>string<\/td><td>no<\/td><td>City in which this server located. Usually present in all responses but occasionally empty or property does not exist. Example: &#8220;Oslo&#8221;<\/td><\/tr><tr><td>country<\/td><td>string<\/td><td>yes<\/td><td>Full name of country in which this server is located; e.g. &#8220;Norway&#8221;<\/td><\/tr><tr><td>country_code<\/td><td>string<\/td><td>yes<\/td><td>2-letter abbreviated country name in which this server is located; e.g. &#8220;NO&#8221; for Norway<\/td><\/tr><tr><td>hasPPTP<\/td><td>string of &#8220;<strong>true<\/strong>&#8221; or &#8220;<strong>false<\/strong>&#8220;<\/td><td>no<\/td><td>stringified boolean. &#8220;true&#8221; if this server supports <strong>legacy PPTP<\/strong> VPN connections; false otherwise or property does not exist<\/td><\/tr><tr><td>hostname<\/td><td>string<\/td><td>yes<\/td><td>FQDN of the server&#8217;s DNS name. Typically of the form aaa.getfoxyproxy.org or aaa.foxyproxy.com or aaa.foxyproxy.io, etc.<\/td><\/tr><tr><td>ipaddress<\/td><td>string<\/td><td>yes<\/td><td>IPv4 address for this server<\/td><\/tr><tr><td>ip<\/td><td>string<\/td><td>yes<\/td><td>alias to ipaddress; IPv4 address for this server<\/td><\/tr><tr><td>ipsec<\/td><td>string of &#8220;<strong>true<\/strong>&#8221; or &#8220;<strong>false<\/strong>&#8220;<\/td><td>no<\/td><td>stringified boolean. &#8220;true&#8221; if this server supports <strong>IPSec<\/strong> VPN connections; false otherwise or property does not exist if this server does not support IPSec VPN<\/td><\/tr><tr><td>ovpnFile<\/td><td>string<\/td><td>no<\/td><td>If this property is present, then its value is an ovpn configuration including PKI certificate. If not present, the server does not support <strong>OpenVPN<\/strong><\/td><\/tr><tr><td>password<\/td><td>string<\/td><td>yes<\/td><td>Password for this account. <strong>For v3 accounts, this is a salted SHA-256 hash of the password.<\/strong> For v1 accounts, this is plaintext. It does not necessarily match the password which was sent in the request.<\/td><\/tr><tr><td>port<\/td><td>array of strings<\/td><td>yes<\/td><td>A stringified list of ports on which the <strong>HTTP proxy server<\/strong> is listening; e.g. [&#8220;19222&#8221;, &#8220;43819&#8221;, &#8220;31001&#8221;]<\/td><\/tr><tr><td>ssl_port<\/td><td>string<\/td><td>yes<\/td><td>A stringified port on which the <strong>SSL\/TLS proxy server<\/strong> is listening; e.g. &#8220;7891&#8221;<\/td><\/tr><tr><td>socks5_port<\/td><td>string<\/td><td>no<\/td><td>A stringified port on which the SOCKS5 proxy server is listening; e.g. &#8220;22819&#8221;. If not present, this server does not support <strong>SOCKS5<\/strong>.<\/td><\/tr><tr><td>username<\/td><td>string<\/td><td>yes<\/td><td>Username for this account. It does not necessarily match the username\/email address which was sent in the request.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Sending the Request To retrieve a list of all server and accounts registered to your email address or username, send an HTTPS POST to https:\/\/getfoxyproxy.org\/webservices\/get-accounts.php Curl example curl &#8211;header &#8220;Content-Type: application\/json&#8221; &#8211;request POST &#8211;data &#8216;{&#8220;username&#8221;:&#8221;AAAAA&#8221;,&#8221;password&#8221;:&#8221;BBBBB&#8221;}&#8217; https:\/\/getfoxyproxy.org\/webservices\/get-accounts.php Note that HTTPS is required. username is either: One of the email addresses under which you are registered One [&hellip;]<\/p>\n","protected":false},"author":4,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[92],"ht-kb-tag":[],"_links":{"self":[{"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/ht-kb\/1499"}],"collection":[{"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/comments?post=1499"}],"version-history":[{"count":4,"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/ht-kb\/1499\/revisions"}],"predecessor-version":[{"id":1504,"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/ht-kb\/1499\/revisions\/1504"}],"wp:attachment":[{"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/media?parent=1499"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/ht-kb-category?post=1499"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/help.getfoxyproxy.com\/index.php\/wp-json\/wp\/v2\/ht-kb-tag?post=1499"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}