Skip to main content
GET
Get instance proxy configuration

Authorizations

token
string
header
required

Response

Proxy configuration retrieved successfully

mode
enum<string>

Client's persisted intent. Represents the mode saved on the instance, not necessarily the transport currently in use.

Available options:
custom,
internal,
none
Example:

"custom"

effective_mode
enum<string>

Connection actually used by the session at this moment.

Available options:
custom,
internal,
direct
Example:

"internal"

effective_detail
enum<string>

Optional detail of the current transport. managed_pool = managed internal proxy. internal_route = dedicated internal route of the environment. relay = client relay tunnel. When there is no additional detail, the field is omitted.

Available options:
managed_pool,
internal_route,
relay
Example:

"managed_pool"

fallback
object

Contingency status. It becomes active when the instance had to leave the configured primary route.

proxy_url
string

Masked URL of the persisted proxy. During custom proxy fallback, it keeps showing the client's URL; it does not switch to the effective contingency proxy.

Example:

"http://***:***@cliente-proxy.example:8080"

proxy_fallback
string

Persisted fallback policy for mode=custom. Accepted values:

  • internal
  • never
  • an HTTP/HTTPS/SOCKS proxy URL for explicit fallback
Example:

"internal"

managed
boolean

Legacy field indicating internal infrastructure involvement. It may be true both in mode=internal and in the internal fallback of mode=custom.

Example:

true

last_test_at
integer

Unix timestamp in milliseconds of the last test or the last persisted failure.

Example:

1760000000000

last_test_error
string

Last persisted error for diagnostics. An empty string means no saved error.

Example:

"dial tcp timeout"

validation_error
boolean

Indicates whether last_test_error is populated.

Example:

true