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 information, see [Manage Scheduled Views](https://help.sumologic.com/?cid=5128).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sumo-logic-scheduledviewmanagement-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sumo Logic Scheduled View Management API
description: '# Getting Started
Welcome to the Sumo Logic API reference.'
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: scheduledViewManagement
description: '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 information, see Manage Scheduled Views.'
x-displayName: Scheduled Views
paths:
/v1/scheduledViews:
get:
tags:
- scheduledViewManagement
summary: Get A List Of Scheduled Views
description: Get a list of all scheduled views in the organization. The response is paginated with a default limit of 100 scheduled views per page.
operationId: listScheduledViews
parameters:
- name: limit
in: query
description: Limit the number of scheduled views returned in the response. The number of scheduled views returned may be less than the `limit`.
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 100
- name: token
in: query
description: Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left.
required: false
schema:
type: string
responses:
'200':
description: A paginated list of scheduled views in the organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ListScheduledViewsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- scheduledViewManagement
summary: Create A New Scheduled View
description: Creates a new scheduled view in the organization.
operationId: createScheduledView
parameters: []
requestBody:
description: Information about the new scheduled view.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduledViewDefinition'
required: true
responses:
'200':
description: The scheduled view has been created.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledView'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-tf-create: createScheduledView
/v1/scheduledViews/{id}:
get:
tags:
- scheduledViewManagement
summary: Get A Scheduled View
description: Get a scheduled view with the given identifier.
operationId: getScheduledView
parameters:
- name: id
in: path
description: Identifier of the scheduled view to fetch.
required: true
schema:
type: string
responses:
'200':
description: Scheduled view object that was requested.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledView'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-tf-read: getScheduledView
put:
tags:
- scheduledViewManagement
summary: Update A Scheduled View
description: Update an existing scheduled view.
operationId: updateScheduledView
parameters:
- name: id
in: path
description: Identifier of the scheduled view to update.
required: true
schema:
type: string
requestBody:
description: Information to update about the scheduled view.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateScheduledViewDefinition'
required: true
responses:
'200':
description: The scheduled view was successfully modified.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledView'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-tf-update: updateScheduledView
/v1/scheduledViews/{id}/disable:
delete:
tags:
- scheduledViewManagement
summary: Disable A Scheduled View
description: Disable a scheduled view with the given identifier.
operationId: disableScheduledView
parameters:
- name: id
in: path
description: Identifier of the scheduled view to disable.
required: true
schema:
type: string
responses:
'204':
description: The scheduled view was disabled successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-tf-delete: deleteScheduledView
/v1/scheduledViews/{id}/pause:
post:
tags:
- scheduledViewManagement
summary: Pause A Scheduled View
description: Pause a scheduled view with the given identifier.
operationId: pauseScheduledView
parameters:
- name: id
in: path
description: Identifier of the scheduled view to pause.
required: true
schema:
type: string
responses:
'200':
description: The scheduled view was paused successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledView'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/scheduledViews/{id}/start:
post:
tags:
- scheduledViewManagement
summary: Start A Scheduled View
description: Start a scheduled view with the given identifier.
operationId: startScheduledView
parameters:
- name: id
in: path
description: Identifier of the scheduled view to start.
required: true
schema:
type: string
responses:
'200':
description: The scheduled view was started successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledView'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/scheduledViews/quota:
get:
tags:
- scheduledViewManagement
summary: Provides Information About Scheduled Views Quota
description: Every customer can use a limited number of scheduled views. This endpoint allows learning about these limitations and remaining quota.
operationId: getScheduledViewsQuota
responses:
'200':
description: Current state of scheduled views quota usage (limit and remaining).
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledViewsQuotaUsage'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ScheduledView:
type: object
allOf:
- $ref: '#/components/schemas/CreateScheduledViewDefinition'
- $ref: '#/components/schemas/ViewRetentionProperties'
- required:
- id
properties:
id:
type: string
description: Identifier for the scheduled view.
indexId:
type: string
description: The `id` of the Index where the output from Scheduled view is stored.
example: '1'
createdAt:
type: string
description: Creation timestamp in UTC.
format: date-time
modifiedAt:
type: string
description: Last modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
createdByOptimizeIt:
type: boolean
description: If the scheduled view is created by OptimizeIt.
error:
type: string
description: Errors related to the scheduled view.
status:
type: string
description: "Status of the scheduled view. Possible values are:\n 1. `NOT_STARTED`\n 2. `FILLING`\n 3. `STOPPED`\n 4. `COMPLETE`\n 5. `FAILED`\n 6. `PAUSED`"
totalBytes:
type: integer
description: Total storage consumed by the scheduled view.
format: int64
totalMessageCount:
type: integer
description: Total number of messages for the scheduled view.
format: int64
createdBy:
type: string
description: Identifier of the user who created the scheduled view.
example: 0000000006743FE8
modifiedBy:
type: string
description: Identifier of the user who last modified the resource.
example: 0000000006743FE8
filledRanges:
type: array
description: List of the different units of filled ranges since the autoview has been created.
items:
$ref: '#/components/schemas/FilledRange'
lastAccessedAt:
type: string
description: Last accessed timestamp in UTC
format: date-time
x-tf-generated-properties: id,query,indexName,startTime,retentionPeriod,parsingMode
x-tf-resource-name: ScheduledView
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'
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
ScheduledViewsQuotaUsage:
required:
- quota
- remaining
type: object
properties:
quota:
type: integer
description: Maximum number of Scheduled Views allowed.
format: int32
example: 200
remaining:
type: integer
description: Remaining number of Scheduled Views allowed.
format: int32
example: 121
ListScheduledViewsResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of scheduled views.
items:
$ref: '#/components/schemas/ScheduledView'
next:
type: string
description: Next continuation token.
UpdateScheduledViewDefinition:
type: object
properties:
dataForwardingId:
type: string
description: An optional ID of a data forwarding configuration to be used by the scheduled view.
retentionPeriod:
type: integer
description: The number of days to retain data in the scheduled view, or -1 to use the default value for your account. Only relevant if your account has multi-retention. enabled.
format: int32
example: 365
default: -1
reduceRetentionPeriodImmediately:
type: boolean
description: This is required if the newly specified `retentionPeriod` is less than the existing retention period. In such a situation, a value of `true` says that data between the existing retention period and the new retention period should be deleted immediately; if `false`, such data will be deleted after seven days. This property is optional and ignored if the specified `retentionPeriod` is greater than or equal to the current retention period.
default: false
timeZone:
type: string
description: Updates the time zone for ingesting data in scheduled view to the specified timezone ( does nothing if not specified ). Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
example: America/Los_Angeles
FilledRange:
required:
- endTime
- startTime
type: object
properties:
startTime:
type: string
description: Start of the timestamp for each unit of filled ranges, expressed in UTC.
format: date-time
endTime:
type: string
description: End of the timestamp for each unit of filled ranges, expressed in UTC.
format: date-time
description: Range of timestamps already filled since the autoview has been created.
CreateScheduledViewDefinition:
required:
- indexName
- query
- startTime
type: object
properties:
query:
maxLength: 16384
minLength: 1
type: string
description: The query that defines the data to be included in the scheduled view.
example: _sourceCategory=*/Apache
indexName:
maxLength: 255
minLength: 0
type: string
description: Name of the index for the scheduled view.
example: TestScheduledView
startTime:
type: string
description: Start timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
retentionPeriod:
type: integer
description: The number of days to retain data in the scheduled view, or -1 to use the default value for your account. Only relevant if your account has multi-retention enabled.
format: int32
example: 60
default: -1
dataForwardingId:
type: string
description: An optional ID of a data forwarding configuration to be used by the scheduled view.
parsingMode:
pattern: ^(AutoParse|Manual)$
type: string
description: "Define the parsing mode to scan the JSON format log messages. Possible values are:\n 1. `AutoParse`\n 2. `Manual`\nIn AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011)."
example: AutoParse
default: Manual
x-pattern-message: should be either AutoParse or Manual
timeZone:
type: string
description: Time zone for ingesting data in scheduled view. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
example: America/Los_Angeles
default: UTC
ViewRetentionProperties:
type: object
properties:
newRetentionPeriod:
type: integer
description: If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time.
format: int32
example: 300
retentionEffectiveAt:
type: string
description: When the newRetentionPeriod will become effective in UTC format.
format: date-time
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