{"openapi":"3.1.0","info":{"title":"Splunk Observability Metrics (BYOK) API","version":"0.1.0","description":"Splunk Observability Metrics (BYOK) lets an AI assistant read your own Splunk Observability Metrics data through the Splunk Observability Metrics API with a key you supply (Splunk Observability Cloud user API access token). Read-only: 8 tools (list_metrics, get_metric, list_dimensions, get_dimension, list_metric_timeseries, get_metric_timeseries, list_tags, get_tag). The BYOK key travels with...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-splunk-observability-metrics.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-splunk-observability-metrics/docs"},"termsOfService":"https://connectorbay.com/byok-splunk-observability-metrics/terms"},"servers":[{"url":"https://byok-splunk-observability-metrics.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-splunk-observability-metrics/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_metrics":{"post":{"operationId":"list_metrics","summary":"Search metric names and metadata (type, description, tags, custom properties). Query syntax: name:<metric> with * wildca","description":"Search metric names and metadata (type, description, tags, custom properties). Query syntax: name:<metric> with * wildcards, for example name:cpu.*. Use for \"Which Splunk Observability metrics start with cpu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"query":{"description":"Metric search string; always starts with name:, for example name:cpu.* (use * as wildcard).","maxLength":200,"title":"Query","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 200).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging (default 0).","title":"Offset"},"order_by":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Property to sort by; prefix with - for descending, and use sf_ in front of built-in fields such as sf_timestamp (for example -sf_timestamp).","title":"Order By"}},"required":["realm","query"],"title":"list_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_metric":{"post":{"operationId":"get_metric","summary":"Get the metadata of one metric by exact name: type, description, tags and custom properties. Use for \"What type of metri","description":"Get the metadata of one metric by exact name: type, description, tags and custom properties. Use for \"What type of metric is cpu.utilization in Splunk Observability\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"name":{"description":"Exact metric name, for example cpu.utilization.","maxLength":200,"title":"Name","type":"string"}},"required":["realm","name"],"title":"get_metricArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dimensions":{"post":{"operationId":"list_dimensions","summary":"Search dimensions and their metadata. Query syntax: key:<dimension name> for names, <name>:<value> for values, * wildcar","description":"Search dimensions and their metadata. Query syntax: key:<dimension name> for names, <name>:<value> for values, * wildcard, _exists_:<name>, AND/OR/NOT. Use for \"Which hosts are known as dimension values in Splunk Observability\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"query":{"description":"Dimension search, for example key:host or host:web-* (wrap values with special characters in double quotes).","maxLength":200,"title":"Query","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 200).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging (default 0).","title":"Offset"},"order_by":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Property to sort by; prefix with - for descending, and use sf_ in front of built-in fields such as sf_timestamp (for example -sf_timestamp).","title":"Order By"}},"required":["realm","query"],"title":"list_dimensionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_dimension":{"post":{"operationId":"get_dimension","summary":"Get the metadata of one dimension value: description, tags and custom properties. Use for \"Show the metadata Splunk Obse","description":"Get the metadata of one dimension value: description, tags and custom properties. Use for \"Show the metadata Splunk Observability has for host web-1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"key":{"description":"Dimension name, for example host.","maxLength":100,"title":"Key","type":"string"},"value":{"description":"Dimension value, for example web-1.","maxLength":200,"title":"Value","type":"string"}},"required":["realm","key","value"],"title":"get_dimensionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_metric_timeseries":{"post":{"operationId":"list_metric_timeseries","summary":"Search metric time series (MTS) metadata: metric name, type, dimensions, tags and custom properties. Query syntax: metri","description":"Search metric time series (MTS) metadata: metric name, type, dimensions, tags and custom properties. Query syntax: metric:<name>, <dimension>:<value>, * wildcard, AND/OR/NOT. Use for \"Which time series exist for cpu.utilization on host web-1 in Splunk Observability\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"query":{"description":"MTS search, for example metric:cpu.utilization AND host:web-1.","maxLength":300,"title":"Query","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 200).","title":"Limit"},"search_inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include inactive time series (default false).","title":"Search Inactive"}},"required":["realm","query"],"title":"list_metric_timeseriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_metric_timeseries":{"post":{"operationId":"get_metric_timeseries","summary":"Get the metadata of one metric time series by its id: metric name, type, dimensions, tags and custom properties. Use for","description":"Get the metadata of one metric time series by its id: metric name, type, dimensions, tags and custom properties. Use for \"Describe Splunk Observability time series AAAAAAAAAAA\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"mts_id":{"description":"Metric time series id from list_metric_timeseries search results.","maxLength":60,"title":"Mts Id","type":"string"}},"required":["realm","mts_id"],"title":"get_metric_timeseriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tags":{"post":{"operationId":"list_tags","summary":"Search tags and their metadata (description and custom properties). Use * as a wildcard, for example prod*. Use for \"Whi","description":"Search tags and their metadata (description and custom properties). Use * as a wildcard, for example prod*. Use for \"Which tags exist in Splunk Observability starting with prod\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"query":{"description":"Tag search string, for example prod* (wrap names with special characters in double quotes).","maxLength":200,"title":"Query","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 200).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging (default 0).","title":"Offset"},"order_by":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Property to sort by; prefix with - for descending, and use sf_ in front of built-in fields such as sf_timestamp (for example -sf_timestamp).","title":"Order By"}},"required":["realm","query"],"title":"list_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_tag":{"post":{"operationId":"get_tag","summary":"Get the metadata of one tag by exact name: description and custom properties. Use for \"What is the Splunk Observability ","description":"Get the metadata of one tag by exact name: description and custom properties. Use for \"What is the Splunk Observability tag prod used for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"realm":{"description":"Splunk Observability Cloud realm of your organization (shown on your profile page), for example us1 or eu0.","enum":["us0","us1","eu0","eu1","eu2","au0","jp0","sg0"],"title":"Realm","type":"string"},"name":{"description":"Exact tag name.","maxLength":100,"title":"Name","type":"string"}},"required":["realm","name"],"title":"get_tagArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}