Hanzo
OpenapiSettings

Reads the caller org's configuration for one product, with every secret field…

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,…

GET /v1/settings/{product}

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

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.

Request

1 field.

FieldInTypeRequiredDescription
productpathstringyesProduct is the catalog slug, from the path.

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 get <product>

Settings API · All Hanzo APIs · Interactive reference

How is this guide?

On this page