Skip to main content
GET
/
api
/
proxy-config
Error
A valid request URL is required to generate request examples
{
  "enabled": true,
  "url": "<string>",
  "username": "<string>",
  "password": "<string>",
  "no_proxy": "<string>",
  "timeout": 123,
  "skip_tls_verify": true,
  "enable_for_scim": true,
  "enable_for_inference": true,
  "enable_for_api": true
}

Authorizations

Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Response

Successful response

Global proxy configuration

enabled
boolean
type
enum<string>
Available options:
http,
socks5,
tcp
url
string
username
string
password
string

Password (redacted as in responses)

no_proxy
string
timeout
integer
skip_tls_verify
boolean
enable_for_scim
boolean
enable_for_inference
boolean
enable_for_api
boolean