v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

scheduledViewManagement

Update a scheduled view.

Update an existing scheduled view.

put/v1/scheduledViews/{id}

Path parameters

idstring required

Identifier of the scheduled view to update.

Request body

dataForwardingIdstring

An optional ID of a data forwarding configuration to be used by the scheduled view.

retentionPeriodinteger

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.

reduceRetentionPeriodImmediatelyboolean

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.

timeZonestring

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.

descriptionstring

Description of the scheduled view.

Example request

{
  "retentionPeriod": 365,
  "timeZone": "America/Los_Angeles"
}

Response

The scheduled view was successfully modified.

querystring required

The query that defines the data to be included in the scheduled view.

indexNamestring required

Name of the index for the scheduled view.

startTimestring date-time required

Start timestamp in UTC in RFC3339 format.

retentionPeriodinteger

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.

dataForwardingIdstring

An optional ID of a data forwarding configuration to be used by the scheduled view.

parsingModestring

Define the parsing mode to scan the JSON format log messages. Possible values are:

AutoParse
Manual In 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.

timeZonestring

Time zone for ingesting data in scheduled view. Follow the format in the IANA Time Zone Database.

descriptionstring

Description of the scheduled view.

newRetentionPeriodinteger

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.

retentionEffectiveAtstring date-time

When the newRetentionPeriod will become effective in UTC format.

idstring required

Identifier for the scheduled view.

indexIdstring

The id of the Index where the output from Scheduled view is stored.

createdAtstring date-time

Creation timestamp in UTC.

modifiedAtstring date-time

Last modification timestamp in UTC in RFC3339 format.

createdByOptimizeItboolean

If the scheduled view is created by OptimizeIt.

errorstring

Errors related to the scheduled view.

statusstring

Status of the scheduled view. Possible values are:

NOT_STARTED
FILLING
STOPPED
COMPLETE
FAILED
PAUSED

totalBytesinteger

Total storage consumed by the scheduled view.

totalMessageCountinteger

Total number of messages for the scheduled view.

createdBystring

Identifier of the user who created the scheduled view.

modifiedBystring

Identifier of the user who last modified the resource.

lastAccessedAtstring date-time

Last accessed timestamp in UTC

Example response

{
  "query": "_sourceCategory=*/Apache",
  "indexName": "TestScheduledView",
  "retentionPeriod": 60,
  "parsingMode": "AutoParse",
  "timeZone": "America/Los_Angeles",
  "newRetentionPeriod": 300,
  "indexId": "1",
  "createdBy": "0000000006743FE8",
  "modifiedBy": "0000000006743FE8"
}