Hanzo
OpenapiO11y

Lists every org-scoped preference, each with its current and default value.

Lists every org-scoped preference, each with its current and default value.

GET /v1/o11y/org/preferences

Addresshttps://api.hanzo.ai/v1/o11y/org/preferences
MethodGET
OperationListOrgPreferences
AuthAuthorization: Bearer $HANZO_API_KEY

Lists every org-scoped preference, each with its current and default value. Admin gate.

Request

GET /v1/o11y/org/preferences takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200o11y.O11yPreferencesOutok

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yPreference[]Data holds the preferences.
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 list

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page