{"openapi":"3.1.0","info":{"title":"Sumo Logic (BYOK) API","version":"0.1.0","description":"Sumo Logic (BYOK) lets an AI assistant read your own Sumo Logic data through the Sumo Logic API with a key you supply (Sumo Logic access ID (US1 deployment, api.sumologic.com)). Read-only: 9 tools (get_account_status, list_partitions, list_dashboards, list_saved_searches, search_monitors, list_extraction_rules, list_fields, list_macros, list_health_events). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sumologic.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sumologic/docs"},"termsOfService":"https://connectorbay.com/byok-sumologic/terms"},"servers":[{"url":"https://byok-sumologic.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sumologic/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/get_account_status":{"post":{"operationId":"get_account_status","summary":"Show the Sumo Logic account status: pricing model, plan type (Free, Trial, Paid), days until the plan expires, credits a","description":"Show the Sumo Logic account status: pricing model, plan type (Free, Trial, Paid), days until the plan expires, credits and whether the account is activated. Use for \"What plan is my Sumo Logic account on\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_statusArguments","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_partitions":{"post":{"operationId":"list_partitions","summary":"List partitions (log indexes) with name, routing expression, data tier, retention days, size in bytes and whether active","description":"List partitions (log indexes) with name, routing expression, data tier, retention days, size in bytes and whether active. Use for \"Which Sumo Logic partitions do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum partitions to return (1 to 1000, default 100).","title":"Limit"},"token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation token from the 'next' field of the previous page; leave out for the first page.","title":"Token"}},"title":"list_partitionsArguments","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_dashboards":{"post":{"operationId":"list_dashboards","summary":"List dashboards with title, description, folder id, whether public, refresh interval and report schedule count. Use for ","description":"List dashboards with title, description, folder id, whether public, refresh interval and report schedule count. Use for \"Which Sumo Logic dashboards exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum dashboards to return (1 to 100, default 50).","title":"Limit"},"token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation token from the 'next' field of the previous page; leave out for the first page.","title":"Token"}},"title":"list_dashboardsArguments","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_saved_searches":{"post":{"operationId":"list_saved_searches","summary":"List saved log searches with name, description, query text, parent folder id and dates. Use for \"Which log searches are ","description":"List saved log searches with name, description, query text, parent folder id and dates. Use for \"Which log searches are saved in Sumo Logic\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum saved searches to return (1 to 100, default 50).","title":"Limit"},"token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation token from the 'next' field of the previous page; leave out for the first page.","title":"Token"}},"title":"list_saved_searchesArguments","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/search_monitors":{"post":{"operationId":"search_monitors","summary":"Search monitors and monitor folders by filter text such as 'type:monitor' or 'monitorStatus:Critical'; returns name, des","description":"Search monitors and monitor folders by filter text such as 'type:monitor' or 'monitorStatus:Critical'; returns name, description, content type, parent folder and path. Use for \"Which Sumo Logic monitors match a filter\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Search text or filters, for example 'type:monitor', 'monitorStatus:Critical' or a name fragment.","maxLength":300,"title":"Query","type":"string"},"limit":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items to return (1 to 5000, default 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Position to start from, for paging.","title":"Offset"}},"required":["query"],"title":"search_monitorsArguments","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_extraction_rules":{"post":{"operationId":"list_extraction_rules","summary":"List field extraction rules with name, scope, parse expression, enabled flag and the fields they extract. Use for \"Which","description":"List field extraction rules with name, scope, parse expression, enabled flag and the fields they extract. Use for \"Which field extraction rules does Sumo Logic have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum rules to return (1 to 1000, default 100).","title":"Limit"},"token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation token from the 'next' field of the previous page; leave out for the first page.","title":"Token"}},"title":"list_extraction_rulesArguments","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_fields":{"post":{"operationId":"list_fields","summary":"List custom fields defined in the account with field name, id, data type and whether enabled. Use for \"Which custom fiel","description":"List custom fields defined in the account with field name, id, data type and whether enabled. Use for \"Which custom fields exist in Sumo Logic\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_fieldsArguments","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_macros":{"post":{"operationId":"list_macros","summary":"List search macros with name, description, definition, enabled flag and creation time. Use for \"Which Sumo Logic search ","description":"List search macros with name, description, definition, enabled flag and creation time. Use for \"Which Sumo Logic search macros exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum macros to return (1 to 100, default 50).","title":"Limit"},"token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation token from the 'next' field of the previous page; leave out for the first page.","title":"Token"}},"title":"list_macrosArguments","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_health_events":{"post":{"operationId":"list_health_events","summary":"List health events (errors and warnings on collectors, sources and ingest budgets) with event name, resource, severity, ","description":"List health events (errors and warnings on collectors, sources and ingest budgets) with event name, resource, severity, subsystem and time. Use for \"Are there Sumo Logic health events\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum events to return (1 to 1000, default 100).","title":"Limit"},"token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation token from the 'next' field of the previous page; leave out for the first page.","title":"Token"}},"title":"list_health_eventsArguments","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}}}}