HThtmlcsstoimage
Proxies

Update a proxy

Changed on

Replaces the complete proxy configuration. Omitted optional settings are cleared or reset. Within authentication, an omitted password requires retain_password: true and an unchanged username. Omitted or null authentication removes credentials.

Rate limit: 20 requests per minute per organization, shared across all operations in the proxy:write group and all API keys belonging to that organization.

post/v1/proxies/{id}

Request

  • Base URL
    https://hcti.io
  • URL
    https://hcti.io/v1/proxies/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Request body

namestring required

Display name for the proxy, between 3 and 500 characters. Leading and trailing whitespace is removed; the resulting name must contain at least 3 characters.

urlstring uri required

Absolute HTTP or HTTPS proxy server URL, up to 512 characters, for example https://proxy.example.com. Supply the port and credentials in their separate fields. Paths other than /, query strings, and fragments are not allowed.

disabledboolean

Whether the proxy is disabled. Defaults to false.

bypass_hostsstring[] nullable

Up to 100 hosts that should bypass the proxy. Entries may be hostnames, IP addresses, or absolute URLs; URLs are reduced to their hostnames. Hosts are normalized to lowercase and duplicates removed. Replaces the complete list; omitted, null, or [] clears it.

Response

OK

idstring required
namestring required
urlstring required
bypass_hostsstring[] required
usernamestring nullable

Configured proxy username, or null when authentication is not configured. An empty string is a valid username. Passwords are never returned.

enabledboolean

Whether the proxy is enabled.

created_atstring date-time
updated_atstring date-time

Changes