curl --request GET \
--url https://api.wppfy.com/instance/proxy \
--header 'token: <api-key>'import requests
url = "https://api.wppfy.com/instance/proxy"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.wppfy.com/instance/proxy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/instance/proxy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/instance/proxy"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.wppfy.com/instance/proxy")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/instance/proxy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"mode": "custom",
"effective_mode": "custom",
"fallback": {
"active": false,
"reason": "",
"since": 0
},
"proxy_url": "http://***:***@cliente-proxy.example:8080",
"proxy_fallback": "internal",
"managed": false,
"last_test_at": 0,
"last_test_error": "",
"validation_error": false
}Get instance proxy configuration
Shows the desired configuration and the connection route used by the instance at the moment. Use it to confirm whether the chosen proxy is active or whether an alternative route was applied to preserve the connection.
modereports the chosen configuration:custom,internalornone.effective_modereports the connection in use:custom,internalordirect.fallback.activeindicates that the main route is not available.proxy_urlreturns the configured URL with masked credentials.last_test_errorhelps diagnose the last known failure.
Under normal conditions, mode and effective_mode match. During a
contingency, they may diverge without changing the saved preference. Do not use
this endpoint for continuous polling; also monitor GET /instance/status.
curl --request GET \
--url https://api.wppfy.com/instance/proxy \
--header 'token: <api-key>'import requests
url = "https://api.wppfy.com/instance/proxy"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.wppfy.com/instance/proxy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/instance/proxy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/instance/proxy"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.wppfy.com/instance/proxy")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/instance/proxy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"mode": "custom",
"effective_mode": "custom",
"fallback": {
"active": false,
"reason": "",
"since": 0
},
"proxy_url": "http://***:***@cliente-proxy.example:8080",
"proxy_fallback": "internal",
"managed": false,
"last_test_at": 0,
"last_test_error": "",
"validation_error": false
}Authorizations
Response
Proxy configuration retrieved successfully
Client's persisted intent. Represents the mode saved on the instance, not necessarily the transport currently in use.
custom, internal, none "custom"
Connection actually used by the session at this moment.
custom, internal, direct "internal"
Optional detail of the current transport.
managed_pool = managed internal proxy.
internal_route = dedicated internal route of the environment.
relay = client relay tunnel.
When there is no additional detail, the field is omitted.
managed_pool, internal_route, relay "managed_pool"
Contingency status. It becomes active when the instance had to leave the configured primary route.
Show child attributes
Show child attributes
Masked URL of the persisted proxy. During custom proxy fallback, it keeps showing the client's URL; it does not switch to the effective contingency proxy.
"http://***:***@cliente-proxy.example:8080"
Persisted fallback policy for mode=custom.
Accepted values:
internalnever- an HTTP/HTTPS/SOCKS proxy URL for explicit fallback
"internal"
Legacy field indicating internal infrastructure involvement. It may be true both in mode=internal and in the internal fallback of mode=custom.
true
Unix timestamp in milliseconds of the last test or the last persisted failure.
1760000000000
Last persisted error for diagnostics. An empty string means no saved error.
"dial tcp timeout"
Indicates whether last_test_error is populated.
true
