Search ingestion keys

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
namequerystring—Name is the substring to match ingestion-key names against.
pagequeryinteger—Page is the 1-based page number.
per_pagequeryinteger—PerPage is the page size.

Response

StatusBodyMeaning
200o11y.O11yIngestionKeysOutok
202Approvalheld for approval
defaultproblem-detailsrefused

200 body — 37 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableIngestionKeys—
data._paginationbodyo11y.Pagination—
data._pagination.pagebodyinteger (int64)—
data._pagination.pagesbodyinteger (int64)—
data._pagination.per_pagebodyinteger (int64)—
data._pagination.totalbodyinteger (int64)—
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 (int64)—
data.keys[].limits[].config.day.sizebodyinteger (int64)—
data.keys[].limits[].config.secondbodyo11y.LimitValue—
data.keys[].limits[].config.second.countbodyinteger (int64)—
data.keys[].limits[].config.second.sizebodyinteger (int64)—
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 (int64)—
data.keys[].limits[].metric.day.sizebodyinteger (int64)—
data.keys[].limits[].metric.secondbodyo11y.LimitMetricValue—
data.keys[].limits[].metric.second.countbodyinteger (int64)—
data.keys[].limits[].metric.second.sizebodyinteger (int64)—
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—
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y gateway ingestion_keys search
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.searchIngestionKeys();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).search_ingestion_keys()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.SearchIngestionKeys(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::search_ingestion_keys(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).searchIngestionKeys();
curl https://api.hanzo.ai/v1/o11y/gateway/ingestion_keys/search \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool o11y, op SearchIngestionKeys — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "SearchIngestionKeys",
           "input": {}
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?