Hanzo
OpenapiSettings

Writes the caller org's configuration for one product and answers the stored…

Writes the caller org's configuration for one product and answers the stored result, secrets masked.

PUT /v1/settings/{product}

Addresshttps://api.hanzo.ai/v1/settings/{product}
MethodPUT
Operationput_settings_by_product
AuthAuthorization: Bearer $HANZO_API_KEY

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.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
productpathstringyesProduct is the catalog slug, from the PATH.
configbodyobjectConfig is the product's non-secret configuration, stored verbatim.
config.*bodyobject
productbodystringProduct is the catalog slug, from the PATH.
secretsbodyobjectSecrets are the secret fields, by name. Each VALUE is sealed into KMS and never reaches this deployment's database; a value that is empty or equal to the mask…
secrets.*bodystring

Response

StatusBodyMeaning
200settingsViewok

200 body — 5 fields.

FieldInTypeAlwaysDescription
configbodyanyConfig is the product's non-secret configuration, an opaque JSON object the server stores and returns verbatim.
createdAtbodystringCreatedAt is when this configuration was first written, RFC 3339 UTC.
productbodystringProduct is the catalog slug this configuration belongs to.
secretKeysbodystring[]SecretKeys names the secret fields that ARE set.
updatedAtbodystringUpdatedAt is when this configuration was last written, RFC 3339 UTC.

Failure carries the platform error shape — see Errors.

Examples

hanzo settings set <product>

Settings API · All Hanzo APIs · Interactive reference

How is this guide?

On this page