Pular para o conteúdo principal
GET
/
api
/
instance
/
getProxy
/
:instance
Verificar 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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Retorna apenas o proxy individual da instância (não inclui fallback para o proxy global do deploy). Se a instância não tem proxy próprio, retorna enabled: false com os demais campos vazios. A senha não é retornada.

​
Exemplo

Faz GET no path da instância e devolve o objeto proxy com a configuração ativa (sem incluir a password). Se a instância não tem proxy individual, vem com enabled: false e os demais campos null. 
curl -X GET "https://ryzeapi.cloud/api/instance/getProxy/minha-instancia" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.exemplo.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1"
  }
}
O campo password nunca é retornado por este endpoint.

​
Path parameters

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Erros

HTTPerror.messageQuando
401Invalid tokenToken ausente ou inválido.
404Instance not foundNome não existe.
429Rate limit exceeded. Try again later.Mais de 100 req/min.
500Failed to get proxy configurationErro de banco.
{
  "success": false,
  "error": {
    "message": "Instance not found"
  }
}

​
Notas

Este endpoint não expõe o proxy global do deploy intencionalmente, você só vê o que configurou para esta instância.

​
Próximo

Atualizar proxy

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