Leer proxy

GET

api

instance

getProxy

:instance

Leer proxy

curl --request GET \
  --url https://api.example.com/api/instance/getProxy/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

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

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

Descripción

Devuelve solo el proxy individual de la instancia (no incluye el fallback al proxy global del deploy). Si la instancia no tiene proxy propio, devuelve enabled: false con los demás campos vacíos. La contraseña no se devuelve.

Ejemplo

Realiza un GET en la ruta de la instancia y devuelve el objeto proxy con la configuración activa (sin incluir el password). Si la instancia no tiene proxy individual, viene con enabled: false y los demás campos null.

curl -X GET "https://ryzeapi.cloud/api/instance/getProxy/my-instance" \
  -H "token: $Token_Instance"

await fetch("https://ryzeapi.cloud/api/instance/getProxy/my-instance", {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/instance/getProxy/my-instance",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/instance/getProxy/my-instance", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Respuesta exitosa

Con proxy
Sin proxy

200 OK

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

200 OK

{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": false,
    "host": null,
    "port": null,
    "protocol": null,
    "username": null
  }
}

El campo password nunca es devuelto por este endpoint.

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Errores

HTTP	`error.message`	Cuándo
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 get proxy configuration`	Error de base de datos.

{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

Notas

Este endpoint no expone el proxy global del deploy intencionalmente, solo ves lo que configuraste para esta instancia.

Actualizar proxy

POST /api/instance/proxy/:instance para cambiar.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Errores

Notas

Siguiente

Actualizar proxy

​Descripción

​Ejemplo

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Errores

​Notas

​Siguiente

Actualizar proxy

Descripción

Ejemplo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Errores

Notas

Siguiente