Definir Proxy

POST

api

instance

proxy

:instance

Definir Proxy

curl --request POST \
  --url https://api.example.com/api/instance/proxy/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "enabled": true,
  "host": "<string>",
  "port": "<string>",
  "protocol": "<string>",
  "username": "<string>",
  "password": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    enabled: true,
    host: '<string>',
    port: '<string>',
    protocol: '<string>',
    username: '<string>',
    password: '<string>'
  })
};

fetch('https://api.example.com/api/instance/proxy/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/instance/proxy/:instance"

payload = {
    "enabled": True,
    "host": "<string>",
    "port": "<string>",
    "protocol": "<string>",
    "username": "<string>",
    "password": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Define proxy HTTP, HTTPS ou SOCKS5 específico da instância. A configuração só toma efeito após /reconnect ou novo /connect.

Exemplos

SOCKS5 autenticado

Configura um proxy SOCKS5 na porta 1080 com usuário e senha. A senha é encriptada at-rest com AES-256-GCM e nunca volta em plaintext na resposta.

curl -X POST "https://ryzeapi.cloud/api/instance/proxy/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "host": "proxy.exemplo.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1",
    "password": "secret"
  }'

await fetch("https://ryzeapi.cloud/api/instance/proxy/minha-instancia", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    enabled:  true,
    host:     "proxy.exemplo.com",
    port:     "1080",
    protocol: "socks5",
    username: "user1",
    password: "secret"
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/proxy/minha-instancia",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "enabled":  True,
        "host":     "proxy.exemplo.com",
        "port":     "1080",
        "protocol": "socks5",
        "username": "user1",
        "password": "secret"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "enabled":  true,
        "host":     "proxy.exemplo.com",
        "port":     "1080",
        "protocol": "socks5",
        "username": "user1",
        "password": "secret"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/proxy/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

HTTP sem auth

Aponta para um proxy HTTP interno (10.0.0.5:3128) sem credenciais, cenário comum em redes corporativas com auth-by-IP ou proxy aberto.

curl -X POST "https://ryzeapi.cloud/api/instance/proxy/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"host":"10.0.0.5","port":"3128","protocol":"http"}'

await fetch("https://ryzeapi.cloud/api/instance/proxy/minha-instancia", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    enabled:  true,
    host:     "10.0.0.5",
    port:     "3128",
    protocol: "http"
  })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/proxy/minha-instancia",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "enabled":  True,
        "host":     "10.0.0.5",
        "port":     "3128",
        "protocol": "http"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"enabled":true,"host":"10.0.0.5","port":"3128","protocol":"http"}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/proxy/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Desabilitar

Envia apenas enabled: false para remover o proxy individual da instância. Ela volta a usar o proxy global do deploy (se houver) ou conexão direta na próxima reconexão.

curl -X POST "https://ryzeapi.cloud/api/instance/proxy/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

await fetch("https://ryzeapi.cloud/api/instance/proxy/minha-instancia", {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ enabled: false })
});

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/proxy/minha-instancia",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"enabled": False}
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"enabled":false}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/proxy/minha-instancia", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Resposta de sucesso

200 OK

{
  "success": true,
  "message": "Proxy configuration updated successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.exemplo.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1",
    "password": ""
  }
}

O password aparece como string vazia ("") na resposta, o servidor nunca devolve a senha em plaintext.

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json.

Request body

boolean

obrigatório

Ativa/desativa o proxy de instância.

string

IP ou hostname. Obrigatório se enabled=true.

string

Porta como string ("1080", "8080"). Obrigatório se enabled=true.

string

"http", "https" ou "socks5". Obrigatório se enabled=true.

string

Usuário (opcional).

string

Senha (opcional, encriptada at-rest).

Regras

enabled=true exige host, port e protocol.
protocol deve ser http, https ou socks5.
username / password são opcionais (proxy aberto ou auth-by-IP).
enabled=false faz a instância voltar a usar o proxy padrão do deploy (se houver).
A senha é encriptada at-rest (AES-256-GCM) e redigida na resposta.

Notas

O proxy individual da instância tem prioridade sobre o proxy global do deploy. Se enabled=false, a instância usa o proxy global (se houver) ou conexão direta.

Mudanças no proxy não reconectam automaticamente, chame reconnect para aplicar.

Erros

HTTP	`error.message`	Quando
400	`Invalid request body`	JSON malformado.
400	`Host is required when proxy is enabled`	`enabled=true` sem `host`.
400	`Port is required when proxy is enabled`	`enabled=true` sem `port`.
400	`Protocol is required when proxy is enabled`	`enabled=true` sem `protocol`.
400	`Protocol must be one of: http, https, socks5`	`protocol` fora do enum.
401	`Invalid token`	Token ausente ou inválido.
404	`Instance not found`	Nome não existe.
429	`Rate limit exceeded. Try again later.`	Mais de 100 req/min.
500	`Failed to update proxy configuration`	Erro de banco.

{
  "success": false,
  "error": {
    "message": "Protocol must be one of: http, https, socks5"
  }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

SOCKS5 autenticado

HTTP sem auth

Desabilitar

Resposta de sucesso

Path parameters

Headers

Request body

Regras

Notas

Erros

​Descrição

​Exemplos

​SOCKS5 autenticado

​HTTP sem auth

​Desabilitar

​Resposta de sucesso

​Path parameters

​Headers

​Request body

​Regras

​Notas

​Erros

Descrição

Exemplos

SOCKS5 autenticado

HTTP sem auth

Desabilitar

Resposta de sucesso

Path parameters

Headers

Request body

Regras

Notas

Erros