Verificar Proxy

GET

api

instance

getProxy

:instance

Verificar 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 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"

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

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

Resposta de sucesso

Com proxy
Sem proxy

200 OK

{
  "success": true,
  "message": "Proxy configuration retrieved successfully",
  "proxy": {
    "enabled": true,
    "host": "proxy.exemplo.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
  }
}

O campo password nunca é retornado por este endpoint.

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Erros

HTTP	`error.message`	Quando
401	`Invalid token`	Token ausente ou inválido.
404	`Instance not found`	Nome não existe.
429	`Rate limit exceeded. Try again later.`	Mais de 100 req/min.
500	`Failed to get proxy configuration`	Erro 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.

Atualizar proxy

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

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Verificar Proxy

Descrição

Exemplo

Resposta de sucesso

Path parameters

Headers

Erros

Notas

Próximo

Atualizar proxy

​Descrição

​Exemplo

​Resposta de sucesso

​Path parameters

​Headers

​Erros

​Notas

​Próximo

Atualizar proxy

Descrição

Exemplo

Resposta de sucesso

Path parameters

Headers

Erros

Notas

Próximo