Saltar al contenido principal
GET
/
api
/
instance
/
getProxy
/
:instance
Leer proxy
curl --request GET \
  --url https://api.example.com/api/instance/getProxy/:instance \
  --header 'token: <token>'

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

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"

​
Respuesta exitosa

200 OK
{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.example.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1"
  }
}
El campo password nunca es devuelto por este endpoint.

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Errores

HTTPerror.messageCuándo
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 get proxy configurationError 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.

​
Siguiente

Actualizar proxy

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