Actualizar proxy

POST

api

instance

proxy

:instance

Actualizar 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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

Descripción

Define un proxy HTTP, HTTPS o SOCKS5 específico para la instancia. La configuración solo surte efecto después de /reconnect o un nuevo /connect.

Ejemplos

SOCKS5 autenticado

Configura un proxy SOCKS5 en el puerto 1080 con usuario y contraseña. La contraseña se cifra at-rest con AES-256-GCM y nunca regresa en texto plano en la respuesta.

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

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

import os, requests

requests.post(
    "https://ryzeapi.cloud/api/instance/proxy/my-instance",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "enabled":  True,
        "host":     "proxy.example.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.example.com",
        "port":     "1080",
        "protocol": "socks5",
        "username": "user1",
        "password": "secret"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/instance/proxy/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

HTTP sin auth

Apunta a un proxy HTTP interno (10.0.0.5:3128) sin credenciales, escenario común en redes corporativas con auth-por-IP o proxy abierto.

curl -X POST "https://ryzeapi.cloud/api/instance/proxy/my-instance" \
  -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/my-instance", {
  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/my-instance",
    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/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Deshabilitar

Envía solo enabled: false para eliminar el proxy individual de la instancia. Vuelve a usar el proxy global del deploy (si lo hay) o una conexión directa en la próxima reconexión.

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

await fetch("https://ryzeapi.cloud/api/instance/proxy/my-instance", {
  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/my-instance",
    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/my-instance", body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Respuesta exitosa

200 OK

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

El password aparece como string vacío ("") en la respuesta, el servidor nunca devuelve la contraseña en texto plano.

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json.

Cuerpo de la solicitud

boolean

requerido

Habilita/deshabilita el proxy de la instancia.

string

IP o hostname. Requerido si enabled=true.

string

Puerto como string ("1080", "8080"). Requerido si enabled=true.

string

"http", "https" o "socks5". Requerido si enabled=true.

string

Usuario (opcional).

string

Contraseña (opcional, cifrada at-rest).

Reglas

enabled=true requiere host, port y protocol.
protocol debe ser http, https o socks5.
username / password son opcionales (proxy abierto o auth-por-IP).
enabled=false hace que la instancia vuelva a usar el proxy default del deploy (si lo hay).
La contraseña es cifrada at-rest (AES-256-GCM) y redactada en la respuesta.

Notas

El proxy individual de la instancia tiene prioridad sobre el proxy global del deploy. Si enabled=false, la instancia usa el proxy global (si lo hay) o conexión directa.

Los cambios de proxy no reconectan automáticamente, llama a reconnect para aplicar.

Errores

HTTP	`error.message`	Cuándo
400	`Invalid request body`	JSON malformado.
400	`Host is required when proxy is enabled`	`enabled=true` sin `host`.
400	`Port is required when proxy is enabled`	`enabled=true` sin `port`.
400	`Protocol is required when proxy is enabled`	`enabled=true` sin `protocol`.
400	`Protocol must be one of: http, https, socks5`	`protocol` fuera del enum.
401	`Invalid token`	Token faltante o inválido.
404	`Instance not found`	Nombre no existe.
429	`Rate limit exceeded. Try again later.`	Más de 100 req/min.
500	`Failed to update proxy configuration`	Error de base de datos.

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Actualizar proxy

Descripción

Ejemplos

SOCKS5 autenticado

HTTP sin auth

Deshabilitar

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Reglas

Notas

Errores

​Descripción

​Ejemplos

​SOCKS5 autenticado

​HTTP sin auth

​Deshabilitar

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Reglas

​Notas

​Errores

Descripción

Ejemplos

SOCKS5 autenticado

HTTP sin auth

Deshabilitar

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Reglas

Notas

Errores