Sumo Logic is a cloud-native, machine data analytics platform delivering real-time, continuous intelligence for operations, security, and business insights. It provides a comprehensive REST API with 289 endpoints spanning log analytics, dashboards, monitors, roles, users, metrics, traces, and more.
Sumo Logic publishes 54 APIs on the APIs.io network, including accessKeyManagement API, accountManagement API, appManagement API, and 51 more. Tagged areas include Logging, Observability, Security, Monitoring, and Analytics.
The Sumo Logic catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.
Sumo Logic’s developer surface includes authentication, developer portal, documentation, getting-started guide, engineering blog, and 8 more developer resources.
Access Key management API. Access Keys allow you to securely register new Collectors and access Sumo Logic APIs. For more information, see [Access Keys](https://help.sumologic.c...
Account Management API. Manage the custom subdomain for the URL used to access your Sumo Logic account. For more information, see [Manage Organization](https://help.sumologic.co...
App installation API. View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction for popular data sources. For more in...
App installation API (V2). View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction for popular data sources. For mo...
Archive Ingestion Management API. Archive Ingestion allows you to ingest data from Archive destinations. You can use this API to ingest data from your Archive with an existing A...
Connection management API. Set up connections to send alerts to other tools. For more information, see [Connections and Integrations](https://help.sumologic.com/?cid=1044).
Content management API. You can export, import, delete and copy content in your organization’s Library. For more information, see [Library](https://help.sumologic.com/?cid=5173)...
Content permissions API. You can share your folders, searches, and dashboards with specific users or roles. For more information, see [Share Content](https://help.sumologic.com/...
Dashboard (New) management API. Dashboard (New) allows you to analyze metric and log data on the same dashboard, in a seamless view. This gives you control over the visual displ...
Data Deletion Rules (Beta) API. Data Deletion Rules allow creating and managing requests to delete log messages satisfying parameters ( query, timerange, etc...). For more infor...
Dynamic Parsing management API. Dynamic Parsing allows automatic field extraction from your log messages when you run a search. This allows you to view fields from logs without ...
Field Extraction Rule management API. Field Extraction Rules allow you to parse fields from your log messages at the time the messages are ingested eliminating the need to parse...
Field management API. Fields allow you to reference log data based on meaningful associations. They act as metadata tags that are assigned to your logs so you can search with th...
Folder management API. You can add folders and subfolders to the Library in order to organize your content for easy access or to share content. For more information, see [Add Fo...
Health Events management API. Health Events allow you to keep track of the health of your Collectors and Sources. You can use them to find and investigate common errors and warn...
Ingest Budget management API V2. Ingest Budgets V2 provide you the ability to create and assign budgets to your log data by Fields instead of using a Field Value. For more infor...
Logs Data Forwarding management API. Logs Data Forwarding allows you to forward log data from a Partition or Scheduled View to an S3 bucket. For more information, see [Forwardin...
Log Search Estimated Usage API. Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier, over a particular time range. In the ...
Log Searches Management API. Whether you are running ad hoc searches during a forensic investigation or running standard searches for health checks, you can save any search to r...
Lookup Table management API. A Lookup Table is a table of data hosted on Sumo Logic that you can use to enrich the log and event data received by Sumo Logic. You must create a t...
Macro Management APIs. Macros allow you to reference a predefined set of query language syntax across multiple queries. This enables reuse of commonly used logic, improves consi...
Metrics Query API. The Metrics Query API allows you to execute queries on various metrics and retrieve multiple time-series (data-points) over time range(s). For more informatio...
Metrics Search management API. Save metrics searches in the content library and organize them in a folder hierarchy. Share useful queries with users in your organization. For mo...
New Metrics Searches Management API. Save metrics searches in the content library and organize them in a folder hierarchy. Allows you to list metrics searches under your persona...
Monitor Management API. Monitors continuously query your data to monitor and send notifications when specific events occur. For more information see [Monitors](https://help.sumo...
Muting Schedules Management API. Muting Schedule allows you to pause alert notifications from monitors. When a muting schedule is active on a monitor, the monitor will still gen...
Parsers Library Management API Customize the Parsers via this API. The Parsers Library contains the Parsers used in the "_parser" field for collector, FER or query. For more inf...
Partition management API. Creating a Partition allows you to improve search performance by searching over a smaller number of messages. For more information, see [Manage Partiti...
Password Policy Management API The password policy controls how user passwords are managed. The "Manage Password Policy" role capability is required to update the password polic...
Policies management API. Policies control the security and share settings of your organization. For more information, see [Security](https://help.sumologic.com/?cid=4041).
Role management API. Roles determine the functions that users are able to perform in Sumo Logic. To manage roles, you must have an administrator role or your role must have been...
Role management API (V2). Roles determine the functions that users are able to perform in Sumo Logic. It also allows to configure access on partitions. To manage roles, you must...
SAML configuration management API Organizations with Enterprise accounts can provision Security Assertion Markup Language (SAML) 2.0 to enable Single Sign-On (SSO) for user acce...
Scheduled View management API. Scheduled Views speed the search process for small and historical subsets of your data by functioning as a pre-aggregated index. For more informat...
Service Allowlist management API Service Allowlist Settings allow you to explicitly grant access to specific IP addresses and/or CIDR notations for logins, APIs, and dashboard a...
Service Map API The Service Map API allows you to fetch a graph representation of the Services Map, which is a high-level view of your application environment, automatically der...
Span Analytics API The Span Analytics API allows you to browse spans collected in the system. You can execute queries to find individual spans matching provided search criteria ...
Threat Intel Datastore Management API The Threat Intel Datastore Management API allows you to: * Get information about the threat indicator datastore and sources. * Delete the t...
Threat Intel Ingestion API The Threat Intel Ingestion API allows you to: * Upload threat intel indicators in STIX 2.x or Sumo normalized format. * Delete indicators by ID or sou...
Tokens management API. Tokens are associated with your organization to authorize specific operations. Currently, we support collector registration tokens, which can be used to r...
Traces API The Traces API allows you to browse traces collected in the system. You can execute queries to find traces matching provided search criteria as well as gather detaile...
Transformation Rule management API. Metrics Transformation Rules allow you control how long raw metrics are retained. You can also aggregate metrics at collection time and speci...
User management API. To manage users, you must have the administrator role or your role must have been assigned the manage users and roles capability. For more information, see ...
This directory contains a conceptual GraphQL schema for the Sumo Logic cloud logging and monitoring platform, derived from the [Sumo Logic REST API v1](https://api.sumologic.com...
aid: sumo-logic
name: Sumo Logic
description: Sumo Logic is a cloud-native, machine data analytics platform delivering real-time, continuous intelligence for
operations, security, and business insights. It provides a comprehensive REST API with 289 endpoints spanning log analytics,
dashboards, monitors, roles, users, metrics, traces, and more.
type: Index
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
label: Freemium · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
position: Consumer
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/sumo-logic.png
tags:
- Logging
- Observability
- Security
- Monitoring
- Analytics
- DevOps
- SIEM
url: https://raw.githubusercontent.com/api-evangelist/sumo-logic/refs/heads/main/apis.yml
created: '2025-01-08'
modified: '2026-05-19'
specificationVersion: '0.19'
apis:
- aid: sumo-logic:sumo-logic-accesskeymanagement-api
name: Sumo Logic accessKeyManagement API
description: 'Access Key management API.
Access Keys allow you to securely register new Collectors and access Sumo Logic APIs. For more information, see [Access
Keys](https://help.sumologic.com/?cid=6690).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- accessKeyManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-accesskeymanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-accountmanagement-api
name: Sumo Logic accountManagement API
description: 'Account Management API.
Manage the custom subdomain for the URL used to access your Sumo Logic account. For more information, see [Manage Organization](https://help.sumologic.com/docs/manage/manage-subscription/manage-org-settings).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- accountManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-accountmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-appmanagement-api
name: Sumo Logic appManagement API
description: 'App installation API.
View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction
for popular data sources. For more information, see [Sumo Logic Apps](https://help.sumologic.com/docs/integrations).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- appManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-appmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-appmanagementv2-api
name: Sumo Logic appManagementV2 API
description: 'App installation API (V2).
View and install Sumo Logic Applications that deliver out-of-the-box dashboards, saved searches, and field extraction
for popular data sources. For more information, see [Sumo Logic Apps](https://help.sumologic.com/docs/integrations).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- appManagementV2
properties:
- type: OpenAPI
url: openapi/sumo-logic-appmanagementv2-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-archivemanagement-api
name: Sumo Logic archiveManagement API
description: 'Archive Ingestion Management API.
Archive Ingestion allows you to ingest data from Archive destinations. You can use this API to ingest data from your Archive
with an existing AWS S3 Archive Source. You need the Manage or View Collectors role capability to manage or view ingestion
jobs. For more information, see [Archive](https://help.sumologic.com/?cid=10011).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- archiveManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-archivemanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-budgetmanagement-api
name: Sumo Logic budgetManagement API
description: Budget Management API.
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- budgetManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-budgetmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-connectionmanagement-api
name: Sumo Logic connectionManagement API
description: 'Connection management API.
Set up connections to send alerts to other tools. For more information, see [Connections and Integrations](https://help.sumologic.com/?cid=1044).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- connectionManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-connectionmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-contentmanagement-api
name: Sumo Logic contentManagement API
description: "Content management API.\n\nYou can export, import, delete and copy content in your organization’s Library.\
\ For more information, see [Library](https://help.sumologic.com/?cid=5173). You can perform the request as a Content\
\ Administrator by using the `isAdminMode` parameter. For more information, see [Admin Mode](https://help.sumologic.com/docs/manage/content-sharing/admin-mode).\n\
<br/> <br/>\n### Example\nThe following example uses API endpoints in the US1 deployment. Sumo Logic has several deployments\
\ that are assigned depending on the geographic location and the date an account is created. For details determining your\
\ account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\nThe [Content Import API](#operation/beginAsyncImport)\
\ can be used to create or update a Search, Scheduled Search, or Dashboard. Here is an example creating a Scheduled Search:\n\
1. Get the identifier of your `Personal` folder.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.sumologic.com/api/v2/content/folders/personal\n\
\ ```\n\n Find the identifier of your `Personal` folder in the response.\n ```json\n {\n ...\n \"id\": \"\
0000000006A2E86F\", <----\n \"name\": \"Personal\",\n \"itemType\": \"Folder\",\n ...\n }\n ```\n\n \
\ You can use [getFolder](#operation/getFolder), [getAdminRecommededFolder](#operation/getAdminRecommendedFolderAsync),\n\
\ or [getGlobalFolder](#operation/getGlobalFolderAsync) endpoints to traverse the content tree and\nfind the identifier\
\ of any\n folder you want to manage.\n\n2. Use the [Content Import API](#operation/beginAsyncImport) to create a new\
\ Scheduled Search inside your\n `Personal` folder.\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" -H \"Content-Type:\
\ application/json\" -d @search.json https://api.sumologic.com/api/v2/content/folders/0000000006A2E86F/import\n ```\n\
\n The data file `search.json` in the above command has the following `SavedSearchWithScheduleSyncDefinition`\nobject.\n\
\ ```json\n // file: search.json\n {\n \"type\": \"SavedSearchWithScheduleSyncDefinition\",\n \"name\": \"\
demo-scheduled-search\",\n \"description\": \"Runs every hour with timerange of 15m and sends email notifications\"\
,\n \"search\": {\n \"queryText\": \"\\\"error\\\" and \\\"warn\\\"\",\n \"defaultTimeRange\":\
\ \"-15m\",\n \"byReceiptTime\": false,\n \"viewName\": \"\",\n \"viewStartTime\": null,\n\
\ \"queryParameters\": []\n },\n \"searchSchedule\": {\n \"cronExpression\": \"0 0/15 * *\
\ * ? *\",\n \"displayableTimeRange\": \"-15m\",\n \"parseableTimeRange\": {\n \"from\"\
: {\n \"relativeTime\": \"-15m\",\n \"type\": \"RelativeTimeRangeBoundary\"\n \
\ },\n \"to\": null,\n \"type\": \"BeginBoundedTimeRange\"\n },\n \"\
timeZone\": \"America/Los_Angeles\",\n \"threshold\": null,\n \"notification\": {\n \"\
taskType\": \"EmailSearchNotificationSyncDefinition\",\n \"toList\": [\n \"ops@acme.org\"\
\n ],\n \"subjectTemplate\": \"Search Results: {{SearchName}}\",\n \"includeQuery\"\
: true,\n \"includeResultSet\": true,\n \"includeHistogram\": true,\n \"includeCsvAttachment\"\
: false\n },\n \"muteErrorEmails\": false,\n \"scheduleType\": \"1Hour\",\n \"parameters\"\
: []\n }\n }\n ```\n\n The response of above request will have the job identifier that you can use to track the\
\ status\nof the import job.\n ```json\n {\n \"id\": \"74DC17FA765C7443\"\n }\n ```\n\n3. Use the job identifier\
\ from the import request to get the [status](#operation/getAsyncImportStatus) of the\n import job.\n ```bash\n curl\
\ -X GET -u \"<accessId>:<accessKey>\" https://api.sumologic.com/api/v2/content/folders/0000000006A2E86F/import/74DC17FA765C7443/status\n\
\ ```\n\n If you are importing a large item, you might have to wait for the import job to finish. The following\nis\
\ an\n example response from a completed job.\n ```json\n {\n \"status\": \"Success\",\n \"statusMessage\"\
: null,\n \"error\": null\n }\n ```"
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- contentManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-contentmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-contentpermissions-api
name: Sumo Logic contentPermissions API
description: 'Content permissions API.
You can share your folders, searches, and dashboards with specific users or roles. For more information, see [Share Content](https://help.sumologic.com/?cid=8675309).
You can perform the request as a Content Administrator by using the `isAdminMode` parameter. For more information, see
[Admin Mode](https://help.sumologic.com/docs/manage/content-sharing/admin-mode).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- contentPermissions
properties:
- type: OpenAPI
url: openapi/sumo-logic-contentpermissions-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-dashboardmanagement-api
name: Sumo Logic dashboardManagement API
description: 'Dashboard (New) management API.
Dashboard (New) allows you to analyze metric and log data on the same dashboard, in a seamless view. This gives you control
over the visual display of metric and log data. Dashboard (New) streamlines dashboard configurations and on-the-fly analytic
visualizations with its new templating features. For more information, see [Dashboard (New)](https://help.sumologic.com/?cid=5500).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- dashboardManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-dashboardmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-datadeletionrules-api
name: Sumo Logic dataDeletionRules API
description: 'Data Deletion Rules (Beta) API.
Data Deletion Rules allow creating and managing requests to delete log messages satisfying parameters ( query, timerange,
etc...). For more information, see [Deletion Requests](https://help.sumologic.com/docs/manage/deletion-requests/)'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- dataDeletionRules
properties:
- type: OpenAPI
url: openapi/sumo-logic-datadeletionrules-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-datamaskingmanagement-api
name: Sumo Logic dataMaskingManagement API
description: 'Data Masking Rules management API.
Data Masking Rules allow you to define regex patterns that mask sensitive data in log messages at query time.'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- dataMaskingManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-datamaskingmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-dynamicparsingrulemanagement-api
name: Sumo Logic dynamicParsingRuleManagement API
description: 'Dynamic Parsing management API.
Dynamic Parsing allows automatic field extraction from your log messages when you run a search. This allows you to view
fields from logs without having to manually specify parsing logic. For more information, see [Dynamic Parsing](https://help.sumologic.com/?cid=20011).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- dynamicParsingRuleManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-dynamicparsingrulemanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-eventanalytics-api
name: Sumo Logic eventAnalytics API
description: 'Event Analytics (Beta) API.
APIs for interacting with events in Sumo Logic.'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- eventAnalytics
properties:
- type: OpenAPI
url: openapi/sumo-logic-eventanalytics-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-extractionrulemanagement-api
name: Sumo Logic extractionRuleManagement API
description: 'Field Extraction Rule management API.
Field Extraction Rules allow you to parse fields from your log messages at the time the messages are ingested eliminating
the need to parse fields in your query. For more information, see [Manage Field Extraction](https://help.sumologic.com/?cid=5313).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- extractionRuleManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-extractionrulemanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-fieldmanagementv1-api
name: Sumo Logic fieldManagementV1 API
description: 'Field management API.
Fields allow you to reference log data based on meaningful associations. They act as metadata tags that are assigned to
your logs so you can search with them. Each field contains a key-value pair, where the field name is the key. Fields may
be referred to as Log Metadata Fields. For more information, see [Fields](https://help.sumologic.com/?cid=10116).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- fieldManagementV1
properties:
- type: OpenAPI
url: openapi/sumo-logic-fieldmanagementv1-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-foldermanagement-api
name: Sumo Logic folderManagement API
description: 'Folder management API.
You can add folders and subfolders to the Library in order to organize your content for easy access or to share content.
For more information, see [Add Folders to the Library](https://help.sumologic.com/?cid=5020). You can perform the request
as a Content Administrator by using the `isAdminMode` parameter. For more information, see [Admin Mode](https://help.sumologic.com/docs/manage/content-sharing/admin-mode).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- folderManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-foldermanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-healthevents-api
name: Sumo Logic healthEvents API
description: 'Health Events management API.
Health Events allow you to keep track of the health of your Collectors and Sources. You can use them to find and investigate
common errors and warnings that are known to cause collection issues. For more information, see [Health Events](https://help.sumologic.com/?cid=0020).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- healthEvents
properties:
- type: OpenAPI
url: openapi/sumo-logic-healthevents-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-ingestbudgetmanagementv2-api
name: Sumo Logic ingestBudgetManagementV2 API
description: 'Ingest Budget management API V2.
Ingest Budgets V2 provide you the ability to create and assign budgets to your log data by Fields instead of using a Field
Value. For more information, see [Metadata Ingest Budgets](https://help.sumologic.com/?cid=52352).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- ingestBudgetManagementV2
properties:
- type: OpenAPI
url: openapi/sumo-logic-ingestbudgetmanagementv2-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-logsdataforwardingmanagement-api
name: Sumo Logic logsDataForwardingManagement API
description: 'Logs Data Forwarding management API.
Logs Data Forwarding allows you to forward log data from a Partition or Scheduled View to an S3 bucket. For more information,
see [Forwarding Data to S3](https://help.sumologic.com/docs/manage/data-forwarding/amazon-s3-bucket).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- logsDataForwardingManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-logsdataforwardingmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-logsearchesestimatedusage-api
name: Sumo Logic logSearchesEstimatedUsage API
description: 'Log Search Estimated Usage API.
Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier, over a particular
time range. In the Infrequent Data Tier, you pay per query, based on the amount data scanned. You can use this endpoint
to get an estimate of the total data that would be scanned before running a query, and refine your query to scan less
data, as necessary. For more information, see [Infrequent data tier](https://help.sumologic.com/?cid=11987).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- logSearchesEstimatedUsage
properties:
- type: OpenAPI
url: openapi/sumo-logic-logsearchesestimatedusage-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-logsearchesmanagement-api
name: Sumo Logic logSearchesManagement API
description: 'Log Searches Management API.
Whether you are running ad hoc searches during a forensic investigation or running standard searches for health checks,
you can save any search to run again later. When you create a search that you would like to reuse, you can save it to
the Library. From there you can run it again, share with others, edit the search, or create a Scheduled Search to run
at a regularly scheduled time, and set up alerts. The saved search will also include any charts you have created in the
Aggregates tab.'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- logSearchesManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-logsearchesmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-lookupmanagement-api
name: Sumo Logic lookupManagement API
description: 'Lookup Table management API.
A Lookup Table is a table of data hosted on Sumo Logic that you can use to enrich the log and event data received by Sumo
Logic. You must create a table schema before you can populate the table. For more information, see [Lookup Tables](https://help.sumologic.com/?cid=10109).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- lookupManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-lookupmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-macromanagement-api
name: Sumo Logic macroManagement API
description: 'Macro Management APIs. Macros allow you to reference a predefined set of query language syntax across multiple
queries. This enables reuse of commonly used logic, improves consistency, and reduces duplication. Macros can optionally
accept arguments. When arguments are provided, the macro evaluates them dynamically and applies the resulting logic within
the query. With the Macro Management APIs, you can create, update, retrieve, and delete macros to simplify and streamline
your query writing process.
For more information, see [Macros](https://www.sumologic.com/help/docs/manage/macro/).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- macroManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-macromanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-metricsquery-api
name: Sumo Logic metricsQuery API
description: 'Metrics Query API.
The Metrics Query API allows you to execute queries on various metrics and retrieve multiple time-series (data-points)
over time range(s). For more information, see [Metrics - Classic](https://help.sumologic.com/?cid=1079).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- metricsQuery
properties:
- type: OpenAPI
url: openapi/sumo-logic-metricsquery-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-metricssearchesmanagement-api
name: Sumo Logic metricsSearchesManagement API
description: 'Metrics Search management API.
Save metrics searches in the content library and organize them in a folder hierarchy. Share useful queries with users
in your organization. For more information, see [Sharing Metric Charts](https://help.sumologic.com/docs/metrics/metric-charts/interacting-metric-charts).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- metricsSearchesManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-metricssearchesmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-metricssearchesmanagementv2-api
name: Sumo Logic metricsSearchesManagementV2 API
description: 'New Metrics Searches Management API.
Save metrics searches in the content library and organize them in a folder hierarchy. Allows you to list metrics searches
under your personal folder.'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- metricsSearchesManagementV2
properties:
- type: OpenAPI
url: openapi/sumo-logic-metricssearchesmanagementv2-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-monitorslibrarymanagement-api
name: Sumo Logic monitorsLibraryManagement API
description: 'Monitor Management API.
Monitors continuously query your data to monitor and send notifications when specific events occur.
For more information see [Monitors](https://help.sumologic.com/?cid=10020).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- monitorsLibraryManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-monitorslibrarymanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-mutingscheduleslibrarymanagement-api
name: Sumo Logic mutingSchedulesLibraryManagement API
description: 'Muting Schedules Management API.
Muting Schedule allows you to pause alert notifications from monitors. When a muting schedule is active on a monitor,
the monitor will still generate alerts, but no notifications will be sent.
For more information see [Muting Schedules](https://help.sumologic.com/docs/alerts/monitors/muting-schedules).'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- mutingSchedulesLibraryManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-mutingscheduleslibrarymanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
url: graphql/sumo-logic-graphql.md
- aid: sumo-logic:sumo-logic-oauthmanagement-api
name: Sumo Logic oauthManagement API
description: '** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes.
**
APIs to manage OAuth Clients'
humanURL: https://help.sumologic.com/docs/api/
baseURL: https://api.sumologic.com/api
tags:
- oauthManagement
properties:
- type: OpenAPI
url: openapi/sumo-logic-oauthmanagement-api-openapi.yml
- type: Documentation
url: https://help.sumologic.com/docs/api/
- type: Reference
url: https://api.sumologic.com/docs/
- type: GettingStarted
url: https://help.sumologic.com/docs/api/about-apis/getting-started/
- type: GraphQL
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sumo-logic/refs/heads/main/apis.yml