Skip to main content
GET
Ler proxy

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Resposta

Sucesso — corpo de resposta nativo do provedor.

The saved proxy record for the instance. Returns null when no proxy record exists.

id
string

Unique identifier of the proxy record (cuid).

enabled
boolean

Whether the proxy is enabled for this instance.

host
string

Proxy host name or IP address.

port
string

Proxy port.

protocol
string

Proxy protocol (e.g. http, https, socks4, socks5).

username
string

Proxy authentication username.

password
string

Proxy authentication password.

createdAt
string

Timestamp when the proxy record was created (ISO 8601).

updatedAt
string

Timestamp when the proxy record was last updated (ISO 8601).

instanceId
string

Identifier of the instance this proxy belongs to.