Sumo Logic
App · 25 actions
Search your logs and run metrics queries, create, change and switch off monitors, look after collectors, export library content, and list dashboards, scheduled views, users, roles and health events in Sumo Logic. Start workflows when a monitor alert is raised or resolved, a log message matches a query, a health event appears, a user joins or a collector stops reporting.
Actions
| Action | What it does |
|---|---|
| Create hosted collector | Create a hosted collector: a home for sources Sumo Logic runs itself, such as HTTP and cloud sources. |
| Create monitor | Create a monitor that raises a critical alert when a log query's result count, or a metrics query's value, crosses a threshold, and resolves it when it crosses back. |
| Delete collector | Delete a collector and its sources for good. |
| Delete log search | Stop a started log search and free its place: an organization can run 200 at once. |
| Delete monitor | Delete a monitor for good. |
| Disable monitor | Turn a monitor off, so it stops running and sending alerts. |
| Export content | Export a library item (a folder, saved search or dashboard) as its full JSON definition, for a backup or to copy elsewhere. |
| Get account status | Get the account's plan (free, trial or paid), days left on it, credits and whether use is being limited. |
| Get library folder | Get a folder in your Sumo Logic library and the searches, dashboards and folders in it. |
| Get log search messages | Read a page of the log messages a started search has found. |
| Get log search records | Read a page of the result rows an aggregate search (one with count, sum, avg and the like) has made. |
| Get log search status | Check a started log search: whether it has finished and how many messages and rows it has found so far. |
| Get monitor | Get one monitor with its status, queries, trigger conditions and where it sends alerts. |
| List collectors | List the collectors that send data to Sumo Logic, with whether each is still reporting. |
| List dashboards | List your dashboards, or every dashboard you can see. |
| List health events | List unresolved health events: collectors, sources and ingest budgets that have run into trouble. |
| List monitors | List monitors, such as every one with an alert raised now, or those whose name or description has some words. |
| List roles | List your organization's roles, with what each allows and who has it. |
| List scheduled views | List scheduled views: queries Sumo Logic runs all the time into an index of their own, for faster searches. |
| List sources | List the sources a collector gathers from, with each one's kind, category and whether it is collecting. |
| List users | List the people in your Sumo Logic organization, or find one by email. |
| Run log search | Search your logs and wait for the answer: the matching log messages, or for a query with an aggregate such as count, its result rows. |
| Run metrics query | Run a metrics query over a time window and return each time series with its data points. |
| Start log search | Start a log search without waiting for it, for a long search. |
| Update monitor | Rename a monitor, change its description or query, or turn it on or off. |
Create hosted collector
Create a hosted collector: a home for sources Sumo Logic runs itself, such as HTTP and cloud sources. Add its sources in Sumo Logic.
Inputs
- Name
nametextRequired - The collector's name. It must be unique in the account.
- Description
descriptiontext - What it collects.
- Source category
categorytext - The category its data is tagged with, used in searches as _sourceCategory, such as prod/web.
- Time zone
time_zonetext - Its time zone, such as America/New_York. Defaults to UTC.
Outputs
collectorobject- The new collector
Example output
{
"collector": {
"alive": true,
"category": "HTTP Collection",
"collectorType": "Hosted",
"collectorVersion": "",
"description": "An example Hosted Collector",
"id": 102087219,
"lastSeenAlive": 1536618284387,
"name": "My Hosted Collector",
"timeZone": "UTC"
}
}Create monitor
Create a monitor that raises a critical alert when a log query's result count, or a metrics query's value, crosses a threshold, and resolves it when it crosses back. It can email people or notify one of your Sumo Logic connections.
Inputs
- Name
nametextRequired - The monitor's name, shown on its alerts.
- Watch
monitor_typetext - A log query's result count, or a metrics query's value. Defaults to logs.One of:
Logs(Logs (count of log search results)),Metrics(Metrics (value of a metrics query)). - Query
querytextRequired - The log or metrics query the monitor runs.
- Alert when the result is
comparisontextRequired - How the result is compared with the threshold.One of:
GreaterThan(Greater than),GreaterThanOrEqual(Greater than or equal to),LessThan(Less than),LessThanOrEqual(Less than or equal to). - Threshold
thresholdnumberRequired - The number the result is compared with.
- Over the last
windowtext - The window each check looks at. Defaults to 15 minutes.One of:
-5m(5 minutes),-10m(10 minutes),-15m(15 minutes (default)),-30m(30 minutes),-1h(1 hour),-3h(3 hours),-6h(6 hours),-12h(12 hours),-24h(24 hours). - Description
descriptiontext - What the monitor watches for, shown with its alerts.
- Email alerts to
email_recipientslist - Email addresses to tell when the alert is raised and resolved.
- Also notify
notify_connectiontext - A Sumo Logic connection (Slack, PagerDuty, a webhook...) to notify too.
- Folder ID
folder_idtext - The id of the monitors folder to put it in. Leave empty for the top of the monitors library.
Outputs
monitorobject- The monitor
Example output
{
"monitor": {
"createdAt": "2026-11-10T09:00:00Z",
"description": "Too many payment errors.",
"id": "0000000000A1B2C3",
"isDisabled": false,
"modifiedAt": "2026-11-10T09:00:00Z",
"monitorType": "Logs",
"name": "Payment errors",
"notifications": [
{
"notification": {
"connectionType": "Email",
"recipients": [
"oncall@example.com"
],
"subject": "Monitor Alert: {{TriggerType}} on {{Name}}"
},
"runForTriggerTypes": [
"Critical",
"ResolvedCritical"
]
}
],
"parentId": "0000000000000001",
"queries": [
{
"query": "_sourceCategory=prod/web error",
"rowId": "A"
}
],
"status": [
"Normal"
],
"triggers": [
{
"detectionMethod": "LogsStaticCondition",
"threshold": 10,
"thresholdType": "GreaterThan",
"timeRange": "-15m",
"triggerType": "Critical"
}
],
"version": 1
}
}Delete collector
Delete a collector and its sources for good.
Inputs
- Collector
collector_idtextRequired - The collector. Pick one, or give its id from an earlier step.
Outputs
collector_idtext- The collector deleted
deletedtrue/false- Always true once deleted
Example output
{
"collector_id": "102087219",
"deleted": true
}Delete log search
Stop a started log search and free its place: an organization can run 200 at once.
Inputs
- Search job ID
job_idtextRequired - The search job's id, from 'Start log search'.
Outputs
deletedtrue/false- Always true once deleted
job_idtext- The search job's id
Example output
{
"deleted": true,
"job_id": "37589506F194FC80"
}Delete monitor
Delete a monitor for good.
Inputs
- Monitor
monitor_idtextRequired - The monitor. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
monitor_idtext- The monitor deleted
Example output
{
"deleted": true,
"monitor_id": "0000000000A1B2C3"
}Disable monitor
Turn a monitor off, so it stops running and sending alerts. Turn it back on with 'Update monitor'.
Inputs
- Monitor
monitor_idtextRequired - The monitor. Pick one, or give its id from an earlier step.
Outputs
monitorobject- The monitor, now turned off
warningslist- Sumo Logic's warnings, if any
Example output
{
"monitor": {
"createdAt": "2026-11-10T09:00:00Z",
"description": "Too many payment errors.",
"id": "0000000000A1B2C3",
"isDisabled": true,
"modifiedAt": "2026-11-10T09:00:00Z",
"monitorType": "Logs",
"name": "Payment errors",
"notifications": [
{
"notification": {
"connectionType": "Email",
"recipients": [
"oncall@example.com"
],
"subject": "Monitor Alert: {{TriggerType}} on {{Name}}"
},
"runForTriggerTypes": [
"Critical",
"ResolvedCritical"
]
}
],
"parentId": "0000000000000001",
"queries": [
{
"query": "_sourceCategory=prod/web error",
"rowId": "A"
}
],
"status": [
"Disabled"
],
"triggers": [
{
"detectionMethod": "LogsStaticCondition",
"threshold": 10,
"thresholdType": "GreaterThan",
"timeRange": "-15m",
"triggerType": "Critical"
}
],
"version": 1
},
"warnings": []
}Export content
Export a library item (a folder, saved search or dashboard) as its full JSON definition, for a backup or to copy elsewhere.
Inputs
- Content ID
content_idtextRequired - The item's id, from 'Get library folder' or a dashboard's contentId.
Outputs
contentobject- The exported definition, as Sumo Logic gives it
content_idtext- The item exported
content_typetext- Its kind, such as FolderSyncDefinition
job_idtext- The export job's id
nametext- The item's name
Example output
{
"content": {
"children": [],
"description": "",
"name": "Payments",
"type": "FolderSyncDefinition"
},
"content_id": "00000000000A1B2C",
"content_type": "FolderSyncDefinition",
"job_id": "C03E086C137F38B4",
"name": "Payments"
}Get account status
Get the account's plan (free, trial or paid), days left on it, credits and whether use is being limited.
Inputs
None.
Outputs
accountobject- The account's status
Example output
{
"account": {
"accountActivated": true,
"applicationUse": "ALLOWED",
"canUpdatePlan": true,
"logModel": "Tiered",
"planExpirationDays": 27,
"planType": "Trial",
"pricingModel": "credits",
"totalCredits": 0
}
}Get library folder
Get a folder in your Sumo Logic library and the searches, dashboards and folders in it. Without a folder, gets your personal folder.
Inputs
- Folder ID
folder_idtext - The folder's id, from an earlier step. Leave empty for your personal folder.
Outputs
countnumber- How many were returned
folderobject- The folder
itemslist- What is in it
Example output
{
"count": 1,
"folder": {
"createdAt": "2026-11-10T09:00:00Z",
"description": "",
"id": "0000000000000001",
"itemType": "Folder",
"modifiedAt": "2026-11-10T09:00:00Z",
"name": "Personal",
"parentId": "0000000000000001"
},
"items": [
{
"createdAt": "2026-11-10T09:00:00Z",
"description": "",
"id": "00000000000A1B2C",
"itemType": "Folder",
"modifiedAt": "2026-11-10T09:00:00Z",
"name": "Payments",
"parentId": "0000000000000001"
}
]
}Get log search messages
Read a page of the log messages a started search has found. It need not have finished.
Inputs
- Search job ID
job_idtextRequired - The search job's id, from 'Start log search'.
- Start at
offsetnumber - How many to skip, for the next page. Defaults to 0.At least 0.
- How many
limitnumber - How many to return, 1 to 10,000. Defaults to 100.From 1 to 10000.
Outputs
countnumber- How many were returned
field_nameslist- The names of the fields each row has
job_idtext- The search job's id
messageslist- The log messages, each field to its value
next_offsetnumber- Pass as 'Start at' for the next page
Example output
{
"count": 1,
"field_names": [
"_messageid",
"_messagetime",
"_raw",
"_sourcecategory",
"_sourcehost"
],
"job_id": "37589506F194FC80",
"messages": [
{
"_messageid": "-9223372036854774628",
"_messagetime": "1793520000000",
"_raw": "2026-11-10 09:00:00 ERROR payment failed for order 1042",
"_sourcecategory": "prod/web",
"_sourcehost": "web-1"
}
],
"next_offset": 1
}Get log search records
Read a page of the result rows an aggregate search (one with count, sum, avg and the like) has made.
Inputs
- Search job ID
job_idtextRequired - The search job's id, from 'Start log search'.
- Start at
offsetnumber - How many to skip, for the next page. Defaults to 0.At least 0.
- How many
limitnumber - How many to return, 1 to 10,000. Defaults to 100.From 1 to 10000.
Outputs
countnumber- How many were returned
field_nameslist- The names of the fields each row has
job_idtext- The search job's id
next_offsetnumber- Pass as 'Start at' for the next page
recordslist- The result rows, each field to its value
Example output
{
"count": 1,
"field_names": [
"_sourcehost",
"_count"
],
"job_id": "37589506F194FC80",
"next_offset": 1,
"records": [
{
"_count": "42",
"_sourcehost": "web-1"
}
]
}Get log search status
Check a started log search: whether it has finished and how many messages and rows it has found so far.
Inputs
- Search job ID
job_idtextRequired - The search job's id, from 'Start log search'.
Outputs
is_donetrue/false- True once it has gathered all its results
job_idtext- The search job's id
message_countnumber- Messages found so far
pending_errorslist- Errors since the last check
pending_warningslist- Warnings since the last check
record_countnumber- Result rows made so far
statetext- Such as GATHERING RESULTS or DONE GATHERING RESULTS
Example output
{
"is_done": true,
"job_id": "37589506F194FC80",
"message_count": 90,
"pending_errors": [],
"pending_warnings": [],
"record_count": 0,
"state": "DONE GATHERING RESULTS"
}Get monitor
Get one monitor with its status, queries, trigger conditions and where it sends alerts.
Inputs
- Monitor
monitor_idtextRequired - The monitor. Pick one, or give its id from an earlier step.
Outputs
monitorobject- The monitor
Example output
{
"monitor": {
"createdAt": "2026-11-10T09:00:00Z",
"description": "Too many payment errors.",
"id": "0000000000A1B2C3",
"isDisabled": false,
"modifiedAt": "2026-11-10T09:00:00Z",
"monitorType": "Logs",
"name": "Payment errors",
"notifications": [
{
"notification": {
"connectionType": "Email",
"recipients": [
"oncall@example.com"
],
"subject": "Monitor Alert: {{TriggerType}} on {{Name}}"
},
"runForTriggerTypes": [
"Critical",
"ResolvedCritical"
]
}
],
"parentId": "0000000000000001",
"queries": [
{
"query": "_sourceCategory=prod/web error",
"rowId": "A"
}
],
"status": [
"Normal"
],
"triggers": [
{
"detectionMethod": "LogsStaticCondition",
"threshold": 10,
"thresholdType": "GreaterThan",
"timeRange": "-15m",
"triggerType": "Critical"
}
],
"version": 1
}
}List collectors
List the collectors that send data to Sumo Logic, with whether each is still reporting.
Inputs
- Which
collector_filtertext - Only collectors of one kind or state. Defaults to all.One of:
all(All (default)),installed,hosted,alive(Running),dead(Stopped reporting). - Page size
limitnumber - How many to return, 1 to 1,000. Sumo Logic's default is 100.From 1 to 1000.
- Start at
offsetnumber - How many to skip, for the next page. Defaults to 0.At least 0.
Outputs
collectorslist- The collectors
countnumber- How many were returned
Example output
{
"collectors": [
{
"alive": true,
"category": "HTTP Collection",
"collectorType": "Hosted",
"collectorVersion": "",
"description": "An example Hosted Collector",
"id": 102087219,
"lastSeenAlive": 1536618284387,
"name": "My Hosted Collector",
"timeZone": "UTC"
}
],
"count": 1
}List dashboards
List your dashboards, or every dashboard you can see.
Inputs
- Which
modetext - Yours only, or every one you can see. Defaults to yours.One of:
createdByUser(Created by me (default)),allViewableByUser(Every dashboard I can see). - Page size
limitnumber - How many to return, 1 to 100. Sumo Logic's default is 50.From 1 to 100.
- Next page token
page_tokentext - The 'next_page_token' from an earlier page, to get the page after it.
Outputs
countnumber- How many were returned
dashboardslist- The dashboards
next_page_tokentext- Pass as 'Next page token' for the next page; empty at the end
Example output
{
"count": 1,
"dashboards": [
{
"contentId": "00000000000A1B2D",
"description": "",
"folderId": "0000000000000001",
"id": "IbEvLkTd5HbQWAt5LUrTZuXsS5fAYtv3",
"title": "Payments overview"
}
],
"next_page_token": ""
}List health events
List unresolved health events: collectors, sources and ingest budgets that have run into trouble.
Inputs
- Page size
limitnumber - How many to return, 1 to 1,000. Sumo Logic's default is 100.From 1 to 1000.
- Next page token
page_tokentext - The 'next_page_token' from an earlier page, to get the page after it.
Outputs
countnumber- How many were returned
health_eventslist- The health events
next_page_tokentext- Pass as 'Next page token' for the next page; empty at the end
Example output
{
"count": 1,
"health_events": [
{
"details": {
"description": "No data for 30 minutes.",
"error": "No data received",
"trackerId": "SourceNotIngesting"
},
"eventId": "1f2a3b4c5d",
"eventName": "Source not ingesting",
"eventTime": "2026-11-10T08:55:00Z",
"resourceIdentity": {
"id": "101792472",
"name": "collector_logs",
"type": "Source"
},
"severityLevel": "Warning",
"subsystem": "Ingest"
}
],
"next_page_token": ""
}List monitors
List monitors, such as every one with an alert raised now, or those whose name or description has some words.
Inputs
- Status
statustext - Only monitors in this state. Leave empty for all.One of:
AllTriggered(Any alert (critical, warning or missing data)),Critical,Warning,MissingData(Missing data),Normal,Disabled. - Words
search_texttext - Only monitors whose name or description has these words.
- Page size
limitnumber - How many to return, 1 to 1,000. Sumo Logic's default is 100.From 1 to 1000.
- Start at
offsetnumber - How many to skip, for the next page. Defaults to 0.At least 0.
Outputs
countnumber- How many were returned
monitorslist- The monitors
Example output
{
"count": 1,
"monitors": [
{
"createdAt": "2026-11-10T09:00:00Z",
"description": "Too many payment errors.",
"id": "0000000000A1B2C3",
"isDisabled": false,
"modifiedAt": "2026-11-10T09:00:00Z",
"monitorType": "Logs",
"name": "Payment errors",
"path": "/Monitor/Payment errors",
"status": [
"Critical"
]
}
]
}List roles
List your organization's roles, with what each allows and who has it.
Inputs
- Name
nametext - Only the role with this name.
- Page size
limitnumber - How many to return, 1 to 1,000. Sumo Logic's default is 100.From 1 to 1000.
- Next page token
page_tokentext - The 'next_page_token' from an earlier page, to get the page after it.
Outputs
countnumber- How many were returned
next_page_tokentext- Pass as 'Next page token' for the next page; empty at the end
roleslist- The roles
Example output
{
"count": 1,
"next_page_token": "",
"roles": [
{
"capabilities": [
"viewCollectors"
],
"createdAt": "2026-10-01T09:00:00Z",
"description": "Can search logs",
"filterPredicate": "",
"id": "00000000000001DF",
"name": "Analyst",
"systemDefined": false,
"users": [
"0000000000000ABC"
]
}
]
}List scheduled views
List scheduled views: queries Sumo Logic runs all the time into an index of their own, for faster searches.
Inputs
- Page size
limitnumber - How many to return, 1 to 1,000. Sumo Logic's default is 100.From 1 to 1000.
- Next page token
page_tokentext - The 'next_page_token' from an earlier page, to get the page after it.
Outputs
countnumber- How many were returned
next_page_tokentext- Pass as 'Next page token' for the next page; empty at the end
scheduled_viewslist- The scheduled views
Example output
{
"count": 1,
"next_page_token": "",
"scheduled_views": [
{
"createdAt": "2026-11-01T00:00:00Z",
"id": "000000000001C3F9",
"indexName": "payments_errors",
"query": "_sourceCategory=prod/web error",
"retentionPeriod": -1,
"startTime": "2026-11-01T00:00:00Z",
"status": "FILLING"
}
]
}List sources
List the sources a collector gathers from, with each one's kind, category and whether it is collecting.
Inputs
- Collector
collector_idtextRequired - The collector. Pick one, or give its id from an earlier step.
Outputs
collector_idtext- The collector
countnumber- How many were returned
sourceslist- The collector's sources
Example output
{
"collector_id": "25",
"count": 1,
"sources": [
{
"alive": true,
"category": "collector_logs",
"id": 101792472,
"name": "collector_logs",
"sourceType": "LocalFile"
}
]
}List users
List the people in your Sumo Logic organization, or find one by email.
Inputs
- Email
emailtext - Only the user with this email address.
- Sort by
sort_bytext - The order to list them in.One of:
firstName(First name),lastName(Last name),email. - Page size
limitnumber - How many to return, 1 to 1,000. Sumo Logic's default is 100.From 1 to 1000.
- Next page token
page_tokentext - The 'next_page_token' from an earlier page, to get the page after it.
Outputs
countnumber- How many were returned
next_page_tokentext- Pass as 'Next page token' for the next page; empty at the end
userslist- The users
Example output
{
"count": 1,
"next_page_token": "",
"users": [
{
"createdAt": "2026-10-01T09:00:00Z",
"email": "jo@example.com",
"firstName": "Jo",
"id": "0000000000000ABC",
"isActive": true,
"isLocked": false,
"lastLoginTimestamp": "2026-11-09T17:00:00Z",
"lastName": "Bloggs",
"roleIds": [
"00000000000001DF"
]
}
]
}Run log search
Search your logs and wait for the answer: the matching log messages, or for a query with an aggregate such as count, its result rows. Waits up to four minutes.
Inputs
- Query
querytextRequired - The log search query, as you would type it in Sumo Logic, such as _sourceCategory=prod/web error | count by _sourceHost.
- Time range
time_rangetext - How far back to look. Ignored when 'From' is given. Defaults to the last 15 minutes.One of:
15m(Last 15 minutes (default)),1h(Last hour),4h(Last 4 hours),24h(Last 24 hours),7d(Last 7 days). - From
from_timedate and time - Start of a window of your own, instead of the time range.
- To
to_timedate and time - End of the window. Defaults to now.
- Most results
max_resultsnumber - How many messages or rows to return, 1 to 10,000. Defaults to 100.From 1 to 10000.
- Field parsing
parsing_modetext - Whether Sumo Logic also pulls out the fields of JSON log messages. Defaults to only the fields the query names.One of:
Manual(Only the fields the query names (default)),AutoParse(Also pull out fields from JSON logs). - Search by
time_typetext - Which time of each message the window applies to. Defaults to when it was logged.One of:
messageTime(When the message was logged (default)),receiptTime(When Sumo Logic received it),searchableTime(When it became searchable).
Outputs
countnumber- How many were returned
field_nameslist- The names of the fields each row has
is_aggregatetrue/false- True if the query aggregates, so rows are in 'records'
job_idtext- The search job's id
message_countnumber- How many messages matched
messageslist- The matching log messages, each field to its value
record_countnumber- How many result rows the aggregate made
recordslist- The aggregate's result rows
statetext- The search's final state
warningtext- Sumo Logic's warning about the query, if any
Example output
{
"count": 1,
"field_names": [
"_messageid",
"_messagetime",
"_raw",
"_sourcecategory",
"_sourcehost"
],
"is_aggregate": false,
"job_id": "37589506F194FC80",
"message_count": 1,
"messages": [
{
"_messageid": "-9223372036854774628",
"_messagetime": "1793520000000",
"_raw": "2026-11-10 09:00:00 ERROR payment failed for order 1042",
"_sourcecategory": "prod/web",
"_sourcehost": "web-1"
}
],
"record_count": 0,
"records": [],
"state": "DONE GATHERING RESULTS",
"warning": ""
}Run metrics query
Run a metrics query over a time window and return each time series with its data points.
Inputs
- Query
querytextRequired - The metrics query, such as metric=CPU_Total _sourceCategory=prod | avg by _sourceHost.
- Time range
time_rangetext - How far back to look. Ignored when 'From' is given. Defaults to the last 15 minutes.One of:
15m(Last 15 minutes (default)),1h(Last hour),4h(Last 4 hours),24h(Last 24 hours),7d(Last 7 days). - From
from_timedate and time - Start of a window of your own, instead of the time range.
- To
to_timedate and time - End of the window. Defaults to now.
- Bucket size (seconds)
quantization_secondsnumber - Group the data points into buckets this many seconds wide. Leave empty for Sumo Logic's choice.At least 1.
- Combine each bucket by
rolluptext - How the points in a bucket are combined. Defaults to average.One of:
Avg(Average (default)),Sum,Min(Minimum),Max(Maximum),Count.
Outputs
countnumber- How many were returned
messageslist- Warnings or errors about the query
serieslist- The time series
unittext- The values' unit, if Sumo Logic gives one
Example output
{
"count": 1,
"messages": [],
"series": [
{
"dimensions": {
"_sourceHost": "web-1"
},
"metric": "CPU_Total",
"timestamps": [
1793520000000,
1793520060000
],
"values": [
41.5,
44.0
]
}
],
"unit": "%"
}Start log search
Start a log search without waiting for it, for a long search. Check it with 'Get log search status' at least every 30 seconds, or Sumo Logic cancels it.
Inputs
- Query
querytextRequired - The log search query, as you would type it in Sumo Logic, such as _sourceCategory=prod/web error | count by _sourceHost.
- Time range
time_rangetext - How far back to look. Ignored when 'From' is given. Defaults to the last 15 minutes.One of:
15m(Last 15 minutes (default)),1h(Last hour),4h(Last 4 hours),24h(Last 24 hours),7d(Last 7 days). - From
from_timedate and time - Start of a window of your own, instead of the time range.
- To
to_timedate and time - End of the window. Defaults to now.
- Field parsing
parsing_modetext - Whether Sumo Logic also pulls out the fields of JSON log messages. Defaults to only the fields the query names.One of:
Manual(Only the fields the query names (default)),AutoParse(Also pull out fields from JSON logs). - Search by
time_typetext - Which time of each message the window applies to. Defaults to when it was logged.One of:
messageTime(When the message was logged (default)),receiptTime(When Sumo Logic received it),searchableTime(When it became searchable).
Outputs
is_aggregatetrue/false- True if the query aggregates, so read its records
job_idtext- The search job's id
warningtext- Sumo Logic's warning about the query, if any
Example output
{
"is_aggregate": false,
"job_id": "37589506F194FC80",
"warning": ""
}Update monitor
Rename a monitor, change its description or query, or turn it on or off. Everything else about it stays as it is.
Inputs
- Monitor
monitor_idtextRequired - The monitor. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- Query
querytext - A new query, for a monitor with one query. Leave empty to keep it.
- On or off
statetext - Turn the monitor on or off. Leave empty to keep it.One of:
enabled(On (enabled)),disabled(Off (disabled)).
Outputs
monitorobject- The monitor
Example output
{
"monitor": {
"createdAt": "2026-11-10T09:00:00Z",
"description": "Too many payment errors.",
"id": "0000000000A1B2C3",
"isDisabled": false,
"modifiedAt": "2026-11-10T09:00:00Z",
"monitorType": "Logs",
"name": "Payment errors",
"notifications": [
{
"notification": {
"connectionType": "Email",
"recipients": [
"oncall@example.com"
],
"subject": "Monitor Alert: {{TriggerType}} on {{Name}}"
},
"runForTriggerTypes": [
"Critical",
"ResolvedCritical"
]
}
],
"parentId": "0000000000000001",
"queries": [
{
"query": "_sourceCategory=prod/web error",
"rowId": "A"
}
],
"status": [
"Normal"
],
"triggers": [
{
"detectionMethod": "LogsStaticCondition",
"threshold": 10,
"thresholdType": "GreaterThan",
"timeRange": "-15m",
"triggerType": "Critical"
}
],
"version": 2
}
}