Hanzo
OpenapiO11y

Lists the workspace's ingestion keys whose name matches the search, paginated.

Lists the workspace's ingestion keys whose name matches the search, paginated.

GET /v1/o11y/gateway/ingestion_keys/search

Addresshttps://api.hanzo.ai/v1/o11y/gateway/ingestion_keys/search
MethodGET
OperationSearchIngestionKeys
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the workspace's ingestion keys whose name matches the search, paginated. Editor gate.

Request

3 fields.

FieldInTypeRequiredDescription
namequerystringName is the substring to match ingestion-key names against.
pagequeryintegerPage is the 1-based page number.
per_pagequeryintegerPerPage is the page size.

Response

StatusBodyMeaning
200o11y.O11yIngestionKeysOutok

200 body — 37 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableIngestionKeys
data._paginationbodyo11y.Pagination
data._pagination.pagebodyinteger
data._pagination.pagesbodyinteger
data._pagination.per_pagebodyinteger
data._pagination.totalbodyinteger
data.keysbodyo11y.IngestionKey[]
data.keys[].created_atbodystring (date-time)
data.keys[].expires_atbodystring (date-time)
data.keys[].idbodystring
data.keys[].limitsbodyo11y.Limit[]
data.keys[].limits[].configbodyo11y.LimitConfig
data.keys[].limits[].config.daybodyo11y.LimitValue
data.keys[].limits[].config.day.countbodyinteger
data.keys[].limits[].config.day.sizebodyinteger
data.keys[].limits[].config.secondbodyo11y.LimitValue
data.keys[].limits[].config.second.countbodyinteger
data.keys[].limits[].config.second.sizebodyinteger
data.keys[].limits[].created_atbodystring (date-time)
data.keys[].limits[].idbodystring
data.keys[].limits[].key_idbodystring
data.keys[].limits[].metricbodyo11y.LimitMetric
data.keys[].limits[].metric.daybodyo11y.LimitMetricValue
data.keys[].limits[].metric.day.countbodyinteger
data.keys[].limits[].metric.day.sizebodyinteger
data.keys[].limits[].metric.secondbodyo11y.LimitMetricValue
data.keys[].limits[].metric.second.countbodyinteger
data.keys[].limits[].metric.second.sizebodyinteger
data.keys[].limits[].signalbodystring"logs", "traces", "metrics"
data.keys[].limits[].tagsbodystring[]
data.keys[].limits[].updated_atbodystring (date-time)
data.keys[].namebodystring
data.keys[].tagsbodystring[]
data.keys[].updated_atbodystring (date-time)
data.keys[].valuebodystring
data.keys[].workspace_idbodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y gateway ingestion_keys search

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page