Hanzo
OpenapiO11y

Returns one org-scoped preference, by name.

Returns one org-scoped preference, by name.

GET /v1/o11y/org/preferences/{name}

Addresshttps://api.hanzo.ai/v1/o11y/org/preferences/{name}
MethodGET
OperationGetOrgPreference
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one org-scoped preference, by name. Admin gate.

Request

1 field.

FieldInTypeRequiredDescription
namepathstringyes

Response

StatusBodyMeaning
200o11y.O11yPreferenceOutok

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yPreference
data.allowedScopesbodystring[]AllowedScopes are the scopes the preference may be set at — org, user.
data.allowedValuesbodystring[]AllowedValues restricts a string preference to these values.
data.defaultValuebodyobjectDefaultValue is the value before anyone set one.
data.descriptionbodystringDescription says what the preference does.
data.namebodystringName is the preference name.
data.valuebodyobjectValue is the current value.
data.valueTypebodystringValueType is the JSON type a value must have — string, integer, float or boolean.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y org preferences get <name>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page