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
| Address | https://api.hanzo.ai/v1/o11y/gateway/ingestion_keys/search |
| Method | GET |
| Operation | SearchIngestionKeys |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists the workspace's ingestion keys whose name matches the search, paginated. Editor gate.
Request
3 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | query | string | — | Name is the substring to match ingestion-key names against. |
page | query | integer | — | Page is the 1-based page number. |
per_page | query | integer | — | PerPage is the page size. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yIngestionKeysOut | ok |
200 body — 37 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.GettableIngestionKeys | — | |
data._pagination | body | o11y.Pagination | — | |
data._pagination.page | body | integer | — | |
data._pagination.pages | body | integer | — | |
data._pagination.per_page | body | integer | — | |
data._pagination.total | body | integer | — | |
data.keys | body | o11y.IngestionKey[] | — | |
data.keys[].created_at | body | string (date-time) | — | |
data.keys[].expires_at | body | string (date-time) | — | |
data.keys[].id | body | string | — | |
data.keys[].limits | body | o11y.Limit[] | — | |
data.keys[].limits[].config | body | o11y.LimitConfig | — | |
data.keys[].limits[].config.day | body | o11y.LimitValue | — | |
data.keys[].limits[].config.day.count | body | integer | — | |
data.keys[].limits[].config.day.size | body | integer | — | |
data.keys[].limits[].config.second | body | o11y.LimitValue | — | |
data.keys[].limits[].config.second.count | body | integer | — | |
data.keys[].limits[].config.second.size | body | integer | — | |
data.keys[].limits[].created_at | body | string (date-time) | — | |
data.keys[].limits[].id | body | string | — | |
data.keys[].limits[].key_id | body | string | — | |
data.keys[].limits[].metric | body | o11y.LimitMetric | — | |
data.keys[].limits[].metric.day | body | o11y.LimitMetricValue | — | |
data.keys[].limits[].metric.day.count | body | integer | — | |
data.keys[].limits[].metric.day.size | body | integer | — | |
data.keys[].limits[].metric.second | body | o11y.LimitMetricValue | — | |
data.keys[].limits[].metric.second.count | body | integer | — | |
data.keys[].limits[].metric.second.size | body | integer | — | |
data.keys[].limits[].signal | body | string | — | "logs", "traces", "metrics" |
data.keys[].limits[].tags | body | string[] | — | |
data.keys[].limits[].updated_at | body | string (date-time) | — | |
data.keys[].name | body | string | — | |
data.keys[].tags | body | string[] | — | |
data.keys[].updated_at | body | string (date-time) | — | |
data.keys[].value | body | string | — | |
data.keys[].workspace_id | body | string | — | |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y gateway ingestion_keys searchimport { 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 := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.SearchIngestionKeys(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + 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": {}
}
}
}'How is this guide?