Proxy
Set Proxy
Configure proxy for instance
POST
/
proxy
/
set
/
{instanceName}
Set Proxy
curl --request POST \
--url http://localhost:8080/proxy/set/{instanceName} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"enabled": true,
"proxyHost": "<string>",
"proxyPort": "<string>",
"proxyUsername": "<string>",
"proxyPassword": "<string>"
}
'import requests
url = "http://localhost:8080/proxy/set/{instanceName}"
payload = {
"enabled": True,
"proxyHost": "<string>",
"proxyPort": "<string>",
"proxyUsername": "<string>",
"proxyPassword": "<string>"
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
proxyHost: '<string>',
proxyPort: '<string>',
proxyUsername: '<string>',
proxyPassword: '<string>'
})
};
fetch('http://localhost:8080/proxy/set/{instanceName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/proxy/set/{instanceName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'proxyHost' => '<string>',
'proxyPort' => '<string>',
'proxyUsername' => '<string>',
'proxyPassword' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/proxy/set/{instanceName}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"proxyHost\": \"<string>\",\n \"proxyPort\": \"<string>\",\n \"proxyUsername\": \"<string>\",\n \"proxyPassword\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/proxy/set/{instanceName}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"proxyHost\": \"<string>\",\n \"proxyPort\": \"<string>\",\n \"proxyUsername\": \"<string>\",\n \"proxyPassword\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/proxy/set/{instanceName}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"proxyHost\": \"<string>\",\n \"proxyPort\": \"<string>\",\n \"proxyUsername\": \"<string>\",\n \"proxyPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Proxy configured successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data. Proxy configuration is invalid."
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Insufficient permissions to configure proxy"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Instance not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}Authorizations
API Key for authentication (global or instance-specific)
Path Parameters
WhatsApp instance name
Example:
"my-instance"
Body
application/json
⌘I
Set Proxy
curl --request POST \
--url http://localhost:8080/proxy/set/{instanceName} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"enabled": true,
"proxyHost": "<string>",
"proxyPort": "<string>",
"proxyUsername": "<string>",
"proxyPassword": "<string>"
}
'import requests
url = "http://localhost:8080/proxy/set/{instanceName}"
payload = {
"enabled": True,
"proxyHost": "<string>",
"proxyPort": "<string>",
"proxyUsername": "<string>",
"proxyPassword": "<string>"
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
proxyHost: '<string>',
proxyPort: '<string>',
proxyUsername: '<string>',
proxyPassword: '<string>'
})
};
fetch('http://localhost:8080/proxy/set/{instanceName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/proxy/set/{instanceName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'proxyHost' => '<string>',
'proxyPort' => '<string>',
'proxyUsername' => '<string>',
'proxyPassword' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/proxy/set/{instanceName}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"proxyHost\": \"<string>\",\n \"proxyPort\": \"<string>\",\n \"proxyUsername\": \"<string>\",\n \"proxyPassword\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/proxy/set/{instanceName}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"proxyHost\": \"<string>\",\n \"proxyPort\": \"<string>\",\n \"proxyUsername\": \"<string>\",\n \"proxyPassword\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/proxy/set/{instanceName}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"proxyHost\": \"<string>\",\n \"proxyPort\": \"<string>\",\n \"proxyUsername\": \"<string>\",\n \"proxyPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Proxy configured successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data. Proxy configuration is invalid."
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Insufficient permissions to configure proxy"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Instance not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/proxy/set/{instanceName}",
"method": "POST"
}
}