Hanzo
OpenapiFlags

Returns one flag definition by key, or 404 when the caller's store has none…

Returns one flag definition by key, or 404 when the caller's store has none under that key.

GET /v1/flags/defs/{key}

Addresshttps://api.hanzo.ai/v1/flags/defs/{key}
MethodGET
Operationget_flags_defs_by_key
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one flag definition by key, or 404 when the caller's store has none under that key.

Request

1 field.

FieldInTypeRequiredDescription
keypathstringyesKey is the flag key to act on, from the path.

Response

StatusBodyMeaning
200DefRowok

200 body — 5 fields.

FieldInTypeAlwaysDescription
definitionbodyanyDefinition is the flag-definition document the evaluator consumes, kept BYTE-FOR-BYTE as it was written.
keybodystringKey is the flag's primary key in the caller's (org, project) store, and the name evaluation looks it up by.
updated_atbodystringUpdatedAt is when the definition was last written, RFC 3339 UTC.
updated_bybodystringUpdatedBy is the email of the principal who last wrote it.
versionbodyintegerVersion is 1 when the key was created and rises by one on every overwrite.

Failure carries the platform error shape — see Errors.

Examples

hanzo flags defs get <key>

Flags API · All Hanzo APIs · Interactive reference

How is this guide?

On this page