v4

latestOpenAPI 3.0.32026-08-0161180264.4 KB

integrations

proxy

Update secure_proxy whitelist (admin portal only)

Replaces allowed_domains and/or allowed_ips on a secure_proxy use case. At least one of the two fields is required. Validation mirrors the CLI's validateDomainPatterns / validateCidrs. Writes a USECASE_HISTORY row with the admin user's email as changed_by.

Update semantics per field:

omitted — field is not modified; the stored value is preserved.
non-empty array — the stored value is replaced with the supplied list.
empty array ([]) — the list is cleared (stored as []). This is the canonical way to remove all entries. null is not accepted.

Staff-only — same auth gates as GET.

put/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist

Path parameters

integrationIdstring uuid required

The integration ID

useCaseIdstring uuid required

The use case ID

Request body

allowed_domainsstring[]

Exact domain ("api.example.com") or wildcard prefix ("*.example.com"). Wildcards must have at least 2 labels in the suffix. Pass [] to clear all allowed domains.

allowed_ipsstring[]

CIDR-notation IP ranges, e.g. "10.0.0.0/24". Pass [] to clear all allowed IPs.

Response

Updated whitelist (same shape as GET)

vpc_mode'static_ip' | 'secure_link' nullable required

VPC routing mode (read-only). null if not yet set.

allowed_domainsstring[] required

Exact domain ("api.example.com") or wildcard prefix ("*.example.com"). Wildcards must have at least 2 labels in the suffix.

allowed_ipsstring[] required

CIDR-notation IP ranges, e.g. "10.0.0.0/24".