API Reference
OIDC
Platform

Instance

AdminUpdated Sep 11, 2026

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

GET /v1/instance/security

instance:read

Read the instance kill switches (per-flow on/off) and the customer IP allowlist.

PATCH /v1/instance/security

instance:write

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.

PUT /v1/instance/captcha_secret

instance:write

Store the captcha provider secret (write-only, encrypted; never read back). Refused while the captcha provider is none.

DELETE /v1/instance/captcha_secret

instance:write

Clear the stored captcha provider secret for the current provider.

PUT /v1/instance/kerberos_secret

instance:write

Store the per-instance Kerberos/IWA trusted-proxy secret (write-only, encrypted; never read back). Refused while the kerberos strategy is off.

DELETE /v1/instance/kerberos_secret

instance:write

Clear the stored Kerberos/IWA trusted-proxy secret for this instance.

PUT /v1/instance/ldap_connections/:connectionId/bind_password

instance:write

Store an LDAP connection service-account bind password (write-only, encrypted; never read back). The connection must exist in auth_config.ldap.connections.

DELETE /v1/instance/ldap_connections/:connectionId/bind_password

instance:write

Clear the stored bind password for an LDAP connection.

GET /v1/instance

instance:read

Read instance configuration. Never returns the private signing key.

PATCH /v1/instance

instance:write

Update allowed origins and auth config. Wildcard origins are refused.

Was this page helpful?
Instance