Saltar al contenido principal
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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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"
  }'

​
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"}'

​
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}'

​
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

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json.

​
Cuerpo de la solicitud

​
enabled
boolean
requerido
Habilita/deshabilita el proxy de la instancia.
​
host
string
IP o hostname. Requerido si enabled=true.
​
port
string
Puerto como string ("1080", "8080"). Requerido si enabled=true.
​
protocol
string
"http", "https" o "socks5". Requerido si enabled=true.
​
username
string
Usuario (opcional).
​
password
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

HTTPerror.messageCuándo
400Invalid request bodyJSON malformado.
400Host is required when proxy is enabledenabled=true sin host.
400Port is required when proxy is enabledenabled=true sin port.
400Protocol is required when proxy is enabledenabled=true sin protocol.
400Protocol must be one of: http, https, socks5protocol fuera del enum.
401Invalid tokenToken faltante o inválido.
404Instance not foundNombre no existe.
429Rate limit exceeded. Try again later.Más de 100 req/min.
500Failed to update proxy configurationError de base de datos.
{
  "success": false,
  "error": {
    "message": "Protocol must be one of: http, https, socks5"
  }
}