Instance
- Written for
- + Written for
- Deprecated
- + Deprecated
- Applies to
- + Applies to
Instance
Backend API — secret key (Authorization: Bearer sk_…).
10 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.
Method & path | Scope | Idem | Explanation |
|---|---|---|---|
|
| Read the instance kill switches (per-flow on/off) and the customer IP allowlist. | |
|
| Set the instance kill switches and/or IP allowlist. Every CIDR is validated; a malformed one is refused rather than stored as a rule that never matches. | |
|
| Store the captcha provider secret (write-only, encrypted; never read back). Refused while the captcha provider is none. | |
|
| Clear the stored captcha provider secret for the current provider. | |
|
| Store the per-instance Kerberos/IWA trusted-proxy secret (write-only, encrypted; never read back). Refused while the kerberos strategy is off. | |
|
| Clear the stored Kerberos/IWA trusted-proxy secret for this instance. | |
|
| Store an LDAP connection service-account bind password (write-only, encrypted; never read back). The connection must exist in auth_config.ldap.connections. | |
|
| Clear the stored bind password for an LDAP connection. | |
|
| Read instance configuration. Never returns the private signing key. | |
|
| Update allowed origins and auth config. Wildcard origins are refused. |