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

​
Descrição

Define proxy HTTP, HTTPS ou SOCKS5 específico da instância. A configuração só toma efeito após /reconnect ou novo /connect.

​
Exemplos

​
SOCKS5 autenticado

Configura um proxy SOCKS5 na porta 1080 com usuário e senha. A senha é encriptada at-rest com AES-256-GCM e nunca volta em plaintext na resposta. 
curl -X POST "https://ryzeapi.cloud/api/instance/proxy/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "host": "proxy.exemplo.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1",
    "password": "secret"
  }'

​
HTTP sem auth

Aponta para um proxy HTTP interno (10.0.0.5:3128) sem credenciais, cenário comum em redes corporativas com auth-by-IP ou proxy aberto. 
curl -X POST "https://ryzeapi.cloud/api/instance/proxy/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"host":"10.0.0.5","port":"3128","protocol":"http"}'

​
Desabilitar

Envia apenas enabled: false para remover o proxy individual da instância. Ela volta a usar o proxy global do deploy (se houver) ou conexão direta na próxima reconexão. 
curl -X POST "https://ryzeapi.cloud/api/instance/proxy/minha-instancia" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

​
Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Proxy configuration updated successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.exemplo.com",
    "port": "1080",
    "protocol": "socks5",
    "username": "user1",
    "password": ""
  }
}
O password aparece como string vazia ("") na resposta, o servidor nunca devolve a senha em plaintext.

​
Path parameters

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

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json.

​
Request body

​
enabled
boolean
obrigatório
Ativa/desativa o proxy de instância.
​
host
string
IP ou hostname. Obrigatório se enabled=true.
​
port
string
Porta como string ("1080", "8080"). Obrigatório se enabled=true.
​
protocol
string
"http", "https" ou "socks5". Obrigatório se enabled=true.
​
username
string
Usuário (opcional).
​
password
string
Senha (opcional, encriptada at-rest).

​
Regras

  • enabled=true exige host, port e protocol.
  • protocol deve ser http, https ou socks5.
  • username / password são opcionais (proxy aberto ou auth-by-IP).
  • enabled=false faz a instância voltar a usar o proxy padrão do deploy (se houver).
  • A senha é encriptada at-rest (AES-256-GCM) e redigida na resposta.

​
Notas

O proxy individual da instância tem prioridade sobre o proxy global do deploy. Se enabled=false, a instância usa o proxy global (se houver) ou conexão direta.
Mudanças no proxy não reconectam automaticamente, chame reconnect para aplicar.

​
Erros

HTTPerror.messageQuando
400Invalid request bodyJSON malformado.
400Host is required when proxy is enabledenabled=true sem host.
400Port is required when proxy is enabledenabled=true sem port.
400Protocol is required when proxy is enabledenabled=true sem protocol.
400Protocol must be one of: http, https, socks5protocol fora do enum.
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 update proxy configurationErro de banco.
{
  "success": false,
  "error": {
    "message": "Protocol must be one of: http, https, socks5"
  }
}