@platformos/pos-cli

{ "openapi": "3.0.3", "info": { "title": "openobserve", "description": "OpenObserve API documents [https://openobserve.ai/docs/](https://openobserve.ai/docs/)", "contact": { "name": "OpenObserve", "url": "https://openobserve.ai/", "email": "hello@zinclabs.io" }, "license": { "name": "Apache-2.0" }, "version": "0.5.0" }, "paths": { "/api/{org_id}/_bulk": { "post": { "tags": [ "Logs" ], "summary": "_bulk ES compatible ingestion API", "description": "_bulk ES compatible ingestion API", "operationId": "LogsIngestionBulk", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Ingest data (ndjson)", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkResponse" }, "example": { "errors": true, "items": [ { "index": { "_id": 1, "_index": "olympics", "error": { "index": "olympics", "index_uuid": "1", "reason": "Too old data, only last 5 hours data can be ingested. Data discarded.", "shard": "1", "type": "Too old data, only last 5 hours data can be ingested. Data discarded." }, "original_record": { "athlete": "CHASAPIS, Spiridon", "city": "BER", "country": "USA", "discipline": "Swimming", "event": "100M Freestyle For Sailors", "gender": "Men", "medal": "Silver", "onemore": 1, "season": "summer", "sport": "Aquatics", "year": 1986 }, "status": 200 } } ], "took": 2 } } } }, "500": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/_search": { "post": { "tags": [ "Search" ], "summary": "SearchStreamData", "description": "SearchStreamData", "operationId": "SearchSQL", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" }, "example": { "aggs": { "histogram": "select histogram(_timestamp, '30 second') AS zo_sql_key, count(*) AS zo_sql_num from query GROUP BY zo_sql_key ORDER BY zo_sql_key" }, "query": { "end_time": 1675185660872049, "from": 0, "size": 10, "sql": "select * from k8s ", "start_time": 1675182660872049 } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" }, "example": { "aggs": { "agg1": [ { "key": "2023-01-15 14:00:00", "num": 345940 }, { "key": "2023-01-15 19:00:00", "num": 384026 } ] }, "from": 0, "hits": [ { "_p": "F", "_timestamp": 1674213225158000, "kubernetes": { "container_hash": "dkr.ecr.us-west-2.amazonaws.com/openobserve@sha256:3dbbb0dc1eab2d5a3b3e4a75fd87d194e8095c92d7b2b62e7cdbd07020f54589", "container_image": "dkr.ecr.us-west-2.amazonaws.com/openobserve:v0.0.3", "container_name": "openobserve", "docker_id": "eb0983bdb9ff9360d227e6a0b268fe3b24a0868c2c2d725a1516c11e88bf5789", "host": "ip.us-east-2.compute.internal", "namespace_name": "openobserve", "pod_id": "35a0421f-9203-4d73-9663-9ff0ce26d409", "pod_name": "openobserve-ingester-0" }, "log": "[2023-01-20T11:13:45Z INFO actix_web::middleware::logger] 10.2.80.192 \"POST /api/demo/_bulk HTTP/1.1\" 200 68", "stream": "stderr" } ], "scan_size": 28943, "size": 1, "took": 155, "total": 27179431 } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "500": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/alerts": { "get": { "tags": [ "Alerts" ], "summary": "ListAlerts", "description": "ListAlerts", "operationId": "ListAlerts", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertList" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/alerts/destinations": { "get": { "tags": [ "Alerts" ], "summary": "ListDestinations", "description": "ListDestinations", "operationId": "ListDestinations", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertDestinationResponse" } } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/alerts/destinations/{destination_name}": { "get": { "tags": [ "Alerts" ], "summary": "GetDestination", "description": "GetDestination", "operationId": "GetDestination", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "destination_name", "in": "path", "description": "Destination name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDestinationResponse" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Alerts" ], "summary": "CreateDestination", "description": "CreateDestination", "operationId": "CreateDestination", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "destination_name", "in": "path", "description": "Destination name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Destination data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDestination" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Alerts" ], "summary": "DeleteDestination", "description": "DeleteDestination", "operationId": "DeleteAlertDestination", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "destination_name", "in": "path", "description": "Destination name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/alerts/templates": { "get": { "tags": [ "Alerts" ], "summary": "ListTemplates", "description": "ListTemplates", "operationId": "ListTemplates", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DestinationTemplate" } } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/alerts/templates/{template_name}": { "get": { "tags": [ "Alerts" ], "summary": "GetTemplateByName", "description": "GetTemplateByName", "operationId": "GetTemplate", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "template_name", "in": "path", "description": "Template name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationTemplate" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Alerts" ], "summary": "CreateTemplate", "description": "CreateTemplate", "operationId": "CreateTemplate", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "template_name", "in": "path", "description": "Template name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Template data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationTemplate" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Alerts" ], "summary": "DeleteTemplate", "description": "DeleteTemplate", "operationId": "DeleteAlertTemplate", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "template_name", "in": "path", "description": "Template name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/dashboards": { "get": { "tags": [ "Dashboards" ], "summary": "ListDashboards", "description": "ListDashboards", "operationId": "ListDashboards", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboards" } } } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Dashboards" ], "summary": "CreateDashboard", "description": "CreateDashboard", "operationId": "CreateDashboard", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dashboard details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" }, "example": { "description": "Traffic patterns and network performance of the infrastructure", "title": "Network Traffic Overview" } } }, "required": true }, "responses": { "201": { "description": "Dashboard created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/dashboards/{dashboard_id}": { "get": { "tags": [ "Dashboards" ], "summary": "GetDashboard", "description": "GetDashboard", "operationId": "GetDashboard", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "dashboard_id", "in": "path", "description": "Dashboard ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "404": { "description": "Dashboard not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Dashboards" ], "summary": "UpdateDashboard", "description": "UpdateDashboard", "operationId": "UpdateDashboard", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "dashboard_id", "in": "path", "description": "Dashboard ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dashboard details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "required": true }, "responses": { "200": { "description": "Dashboard updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "404": { "description": "Dashboard not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "500": { "description": "Failed to update the dashboard", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Dashboards" ], "summary": "DeleteDashboard", "description": "DeleteDashboard", "operationId": "DeleteDashboard", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "dashboard_id", "in": "path", "description": "Dashboard ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Dashboard deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "404": { "description": "Dashboard not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/enrichment_tables/{table_name}": { "post": { "tags": [ "Functions" ], "summary": "CreateEnrichmentTable", "description": "CreateEnrichmentTable", "operationId": "CreateEnrichmentTable", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "table_name", "in": "path", "description": "Table name", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Saved enrichment table", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/functions": { "get": { "tags": [ "Functions" ], "summary": "ListFunctions", "description": "ListFunctions", "operationId": "listFunctions", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionList" } } } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Functions" ], "summary": "CreateFunction", "description": "CreateFunction", "operationId": "createFunction", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Function data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transform" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/functions/{name}": { "put": { "tags": [ "Functions" ], "summary": "UpdateFunction", "description": "UpdateFunction", "operationId": "updateFunction", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "Function name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Function data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transform" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "400": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Functions" ], "summary": "DeleteFunction", "description": "DeleteFunction", "operationId": "deleteFunction", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "Function name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/ingest/metrics/_json": { "post": { "tags": [ "Metrics" ], "summary": "_json ingestion API", "description": "_json ingestion API", "operationId": "MetricsIngestionJson", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Ingest data (json array)", "content": { "application/json": { "schema": { "type": "string" }, "example": [ { "__name__": "metrics stream name", "__type__": "counter / gauge / histogram / summary", "_timestamp": 1687175143, "label_name1": "label_value1", "label_name2": "label_value2", "value": 1.2 } ] } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionResponse" }, "example": { "code": 200, "status": [ { "failed": 0, "name": "up", "successful": 3 } ] } } } }, "500": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/kv": { "get": { "tags": [ "KV" ], "summary": "ListKeys", "description": "ListKeys", "operationId": "ListKVKeys", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "description": "Key prefix", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/kv/{key}": { "get": { "tags": [ "KV" ], "summary": "GetValue", "description": "GetValue", "operationId": "GetKVValue", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "Key name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "NotFound", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "KV" ], "summary": "SetValue", "description": "SetValue", "operationId": "SetKVValue", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "Key name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Value of the key", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "Error", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "KV" ], "summary": "RemoveValue", "description": "RemoveValue", "operationId": "RemoveKVValue", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "Key name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "NotFound", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/organizations": { "get": { "tags": [ "Organizations" ], "summary": "GetOrganizations", "description": "GetOrganizations", "operationId": "GetUserOrganizations", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/organizations/passcode": { "get": { "tags": [ "Organizations" ], "summary": "GetIngestToken", "description": "GetIngestToken", "operationId": "GetOrganizationUserIngestToken", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasscodeResponse" } } } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Organizations" ], "summary": "UpdateIngestToken", "description": "UpdateIngestToken", "operationId": "UpdateOrganizationUserIngestToken", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasscodeResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/prometheus/api/v1/label/{label_name}/values": { "get": { "tags": [ "Metrics" ], "summary": "prometheus query label values", "description": "prometheus query label values", "operationId": "PrometheusLabelValues", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "label_name", "in": "path", "description": "Label name", "required": true, "schema": { "type": "string" } }, { "name": "match[]", "in": "query", "description": "Series selector argument that selects the series from which to read the label values", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "<rfc3339 | unix_timestamp>: Start timestamp", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "end", "in": "query", "description": "<rfc3339 | unix_timestamp>: End timestamp", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" }, "example": { "data": [ "node", "prometheus" ], "status": "success" } } } }, "500": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/prometheus/api/v1/labels": { "get": { "tags": [ "Metrics" ], "summary": "prometheus getting label names", "description": "prometheus getting label names", "operationId": "PrometheusLabels", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "match[]", "in": "query", "description": "Series selector argument that selects the series from which to read the label names", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "<rfc3339 | unix_timestamp>: Start timestamp", "required": false, "schema": { "type": "string", "nullable": true } }, { "name": "end", "in": "query", "description": "<rfc3339 | unix_timestamp>: End timestamp", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" }, "example": { "data": [ "__name__", "call", "code", "config", "dialer_name", "endpoint", "event", "goversion", "handler", "instance", "interval", "job", "le", "listener_name", "name", "quantile", "reason", "role", "scrape_job", "slice", "version" ], "status": "success" } } } }, "500": { "description": "Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" } } } } }, "security": [ { "Authorization": [] } ] } }, "/api/{org_id}/prometheus/api/v1/metadata": { "get": { "tags": [ "Metrics" ], "summary": "prometheus query metric metadata", "description": "prometheus query metric metadata", "operationId": "PrometheusMetadata", "parameters": [ { "name": "org_id", "in": "path", "description": "Organization name", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of metrics to return", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "description": "A metric name to filter metadata for. All metric metadata is retrieved if left empty", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpResponse" }, "example": { "data": { "cortex_ring_tokens": [ { "help": "Number of tokens in the ring", "type": "gauge", "unit": "" } ], "http_requests_total": [ { "help": "Number of HTTP requests", "type": "counter", "unit": "" }, { "help": "Amount of HTTP requests", "type": "counter", "unit": "" } ] }, "status": "success" } } } }, "500": { "description": "Failure", "content": { "applic