Settings
Package settings is how an org configures each product it uses, secret fields included.
Package settings is how an org configures each product it uses, secret fields included.
| Base URL | https://api.hanzo.ai |
| Operations | 2 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
settings
GET /v1/settings/{product}
Reads the caller org's configuration for one product, with every secret field MASKED — only the names of the set secrets come back, never their values, which live in KMS. A product the org has never configured is not a 404: it answers 200 with an empty config object, so the console's Settings tab always renders and merges its own display defaults on top.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
product | path | string | yes | Product is the catalog slug, from the path. |
PUT /v1/settings/{product}
Writes the caller org's configuration for one product and answers the stored result, secrets masked. Secret VALUES are sealed into KMS under orgs/{org}/settings/{product}/{key} and never touch this deployment's database; with no KMS configured a write that carries any secret is refused whole (503) rather than dropping it or persisting it in the clear. A secret the body omits keeps its stored value, so a partial write never silently clears one.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
product | path | string | yes | Product is the catalog slug, from the PATH. |
Request body — application/json (required)
| Field | Type | Required | Description |
|---|---|---|---|
config | object | — | Config is the product's non-secret configuration, stored verbatim. Bounded at 64 KiB once serialized. |
product | string | — | Product is the catalog slug, from the PATH. |
secrets | object | — | Secrets are the secret fields, by name. Each VALUE is sealed into KMS and never reaches this deployment's database; a… |
How is this guide?