Event Analytics (Beta) API. APIs for interacting with events in Sumo Logic.
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement eventAnalytics API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: eventAnalytics
description: 'Event Analytics (Beta) API.
APIs for interacting with events in Sumo Logic.
'
x-displayName: Event Analytics (Beta)
paths:
/v1/eventExtractionRules:
get:
tags:
- eventAnalytics
summary: Get All Event Extraction Rules.
description: Get all event extraction rules.
operationId: getEventExtractionRules
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: Event extraction rules.
content:
application/json:
schema:
$ref: '#/components/schemas/ListEventExtractionRulesResponse'
post:
tags:
- eventAnalytics
summary: Create Event Extraction Rule.
description: Create event extraction rule.
operationId: createEventExtractionRule
requestBody:
description: Information to create a new event extraction rule.
content:
application/json:
schema:
$ref: '#/components/schemas/EventExtractionRule'
required: true
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: The event extraction rule was created.
content:
application/json:
schema:
$ref: '#/components/schemas/EventExtractionRuleWithDetails'
/v1/eventExtractionRules/quota:
get:
tags:
- eventAnalytics
summary: Get Event Extraction Rules Quota.
description: Every customer can use a limited number of Event Extraction Rules. This endpoint allows learning about these limitations and remaining quota.
operationId: getEventExtractionRulesQuota
responses:
'200':
description: Current state of Event Extraction Rules quota usage (limit and remaining).
content:
application/json:
schema:
$ref: '#/components/schemas/EventExtractionRulesQuotaUsage'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/eventExtractionRules/{id}:
get:
tags:
- eventAnalytics
summary: Get An Event Extraction Rule.
description: Get an event extraction rule.
operationId: getEventExtractionRule
parameters:
- name: id
in: path
description: The identifier of the event extraction rule.
required: true
schema:
type: string
example: 000000000000000A
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: Requested event extraction rule.
content:
application/json:
schema:
$ref: '#/components/schemas/EventExtractionRuleWithDetails'
put:
tags:
- eventAnalytics
summary: Update An Event Extraction Rule.
description: Update an event extraction rule.
operationId: updateEventExtractionRule
parameters:
- name: id
in: path
description: The identifier of the event extraction rule.
required: true
schema:
type: string
example: 000000000000000A
requestBody:
description: Information to update event extraction rule.
content:
application/json:
schema:
$ref: '#/components/schemas/EventExtractionRule'
required: true
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: The event extraction rule was updated.
content:
application/json:
schema:
$ref: '#/components/schemas/EventExtractionRuleWithDetails'
delete:
tags:
- eventAnalytics
summary: Delete An Event Extraction Rule.
description: Delete an event extraction rule.
operationId: deleteEventExtractionRule
parameters:
- name: id
in: path
description: The identifier of the event extraction rule.
required: true
schema:
type: string
example: 000000000000000A
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'204':
description: The event extraction rule was successfully deleted.
components:
schemas:
EventExtractionRule:
required:
- configuration
- name
- query
type: object
properties:
name:
maxLength: 256
minLength: 1
type: string
description: Name of event extraction rule.
example: foo
description:
maxLength: 1024
type: string
description: Description of event extraction rule.
example: foo
query:
type: string
description: "Query string for the Event Extraction Rule. Logs matching this query are periodically ingested into the `sumologic_userdata_events` index (**Events**).\n\nGuidelines for creating the query:\n - Optimize the query to limit the number of returned log messages (intended for special logs only).\n - The query runs in `Manual` mode, explicitly parse and extract only the necessary fields for event correlation and visualization.\n - Use the `fields` operator to restrict the output to required fields.\n"
example: _sourceCategory=eventSource
correlationExpression:
required:
- eventFieldName
- queryFieldName
- stringMatchingAlgorithm
type: object
properties:
queryFieldName:
type: string
description: Name of the query field returned by a log search query.
example: _sourcecategory
eventFieldName:
type: string
description: Name of the field from event query output.
example: foo
stringMatchingAlgorithm:
pattern: ^(ExactMatch)$
type: string
description: Type of string matching algorithm which tells how to match eventFieldName and queryFieldName.
example: ExactMatch
description: "Correlation Expression specifies how to determine related events for a log search query. \nThe value of `eventFieldName` from Events is compared with the values of `queryFieldName` from the log search query output using the defined stringMatchingAlgorithm. Events that match according to this algorithm are considered correlated.\n"
configuration:
maxProperties: 1000
required:
- eventName
- eventPriority
- eventSource
- eventType
type: object
additionalProperties:
$ref: '#/components/schemas/FieldMapping'
description: "Configuration for the Event Extraction Rule.\n\nThis object defines how event fields are mapped to their corresponding values.\nEach field specifies a `valueSource`, which provides the actual value, and an optional `mappingType`,\nindicating the value is hardcoded.\n\nThe following fields are **required**:\n - `eventType`: Type of the event. Accepted values are `Deployment`, `Feature Flag Change`, `Configuration Change` or `Infrastructure Change`.\n - `eventPriority`: Indicates the priority of the event. Accepted values are `High`, `Medium`, or `Low`.\n - `eventSource`: Source system or component where the event originated (e.g., \"Jenkins\").\n - `eventName`: Descriptive name of the event (e.g., \"monitor-manager deployed.\").\n\nThe following fields are **optional**:\n - `eventDescription`: Additional context or details about the event.\n\nCustom fields can also be added as needed to capture domain-specific event data.\n"
example:
eventType:
valueSource: Deploy
mappingType: HardCoded
eventPriority:
valueSource: High
mappingType: HardCoded
eventSource:
valueSource: Jenkins
mappingType: HardCoded
eventName:
valueSource: monitor-manager deployed.
mappingType: HardCoded
eventDescription:
valueSource: 2 containers in monitor-manager were upgraded.
mappingType: HardCoded
EventExtractionRuleWithDetails:
type: object
description: Event extraction rule object.
allOf:
- $ref: '#/components/schemas/EventExtractionRule'
- required:
- id
type: object
properties:
id:
type: string
description: Id of the event extraction rule.
example: '0000000001213227'
createdAt:
type: string
description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
createdBy:
type: string
description: Identifier of the user who created the resource.
modifiedAt:
type: string
description: Last modification timestamp in UTC.
format: date-time
modifiedBy:
type: string
description: Identifier of the user who last modified the resource.
enabled:
type: boolean
description: Flag indicating whether the event extraction rule is enabled or disabled.
example: true
disableReason:
type: string
description: Reason for disabling the event extraction rule, if applicable.
example: Event Extraction Rule output exceeded maximum allowed rate of 1000 events per hour in last 24 hours.
EventExtractionRulesQuotaUsage:
required:
- quota
- remaining
type: object
properties:
quota:
type: integer
description: Maximum number of EventExtractionRules allowed.
format: int32
example: 200
remaining:
type: integer
description: Remaining number of EventExtractionRules allowed.
format: int32
example: 121
FieldMapping:
required:
- valueSource
type: object
properties:
valueSource:
maxLength: 256
type: string
description: The actual value or field reference for the mapping.
example: Knobs Changes
mappingType:
pattern: ^(HardCoded)$
type: string
description: Specifies valueSource is hardcoded.
example: HardCoded
x-pattern-message: Must be `HardCoded`
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
ListEventExtractionRulesResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of event extraction rules.
items:
$ref: '#/components/schemas/EventExtractionRuleWithDetails'
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
- logSearchesManagement
- parsersLibraryManagement
- name: Metrics
tags:
- metricsSearchesManagement
- transformationRuleManagement
- metricsQuery
- metricsSearchesManagementV2
- name: Security Management
tags:
- accessKeyManagement
- oauthManagement
- accountManagement
- passwordPolicy
- policiesManagement
- samlConfigurationManagement
- serviceAllowlistManagement
- serviceAccountManagement
- scimUserManagement
- name: Organizations Management
tags:
- orgsManagement
- name: Settings Management
tags:
- connectionManagement
- dynamicParsingRuleManagement
- extractionRuleManagement
- fieldManagementV1
- partitionManagement
- scheduledViewManagement
- logsDataForwardingManagement
- dataDeletionRules
- name: Tokens Management
tags:
- tokensLibraryManagement
- name: Tracing
tags:
- traces
- spanAnalytics
- serviceMap
- name: Users and Roles Management
tags:
- roleManagement
- roleManagementV2
- userManagement
- name: Threat Intel Ingest Management
tags:
- threatIntelIngest
- threatIntelIngestProducer
- name: OpenTelemetry Collector Management
tags:
- otCollectorManagementExternal
- name: Source Template Management
tags:
- sourceTemplateManagementExternal
- name: Schema Base Management
tags:
- schemaBaseManagement
- name: Event Analytics Management
tags:
- eventAnalytics
- name: Budget Management
tags:
- budgetManagement
- name: Macro Management
tags:
- macroManagement
- name: Muting Schedules Management
tags:
- mutingSchedulesLibraryManagement
- name: SLO Management
tags:
- slosLibraryManagement
- name: Monitor Management
tags:
- monitorsLibraryManagement