Cron Configuration Schema

docs.neops.io/schema/RootWorkflow#/properties/cron/items

Configuration for scheduled workflow executions

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	RootWorkflow.schema.json*

items Type

object (Cron Configuration)

items Properties

Property	Type	Required	Nullable	Defined by
concurrency	boolean	Required	cannot be null	Root Workflow
condition	string	Optional	cannot be null	Root Workflow
crontab	object	Required	cannot be null	Root Workflow
description	string	Required	cannot be null	Root Workflow
enabled	boolean	Required	cannot be null	Root Workflow
parameters	object	Required	cannot be null	Root Workflow
query	string	Required	cannot be null	Root Workflow
title	string	Required	cannot be null	Root Workflow

concurrency

Whether multiple instances of this scheduled job can run simultaneously

concurrency

• is required

• Type: boolean (Allow Concurrency)

• cannot be null

• defined in: Root Workflow

concurrency Type

boolean (Allow Concurrency)

concurrency Examples

false

condition

A JMESPath expression that evaluates to a boolean value

condition

• is optional

• Type: string (Condition)

• cannot be null

• defined in: Root Workflow

condition Type

string (Condition)

condition Constraints

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[^{}]+$

try pattern

condition Examples

"device_count > 0"

crontab

Configuration for cron-style scheduling following standard cron syntax with seconds precision.

crontab

• is required

• Type: object (Crontab Configuration)

• cannot be null

• defined in: Root Workflow

crontab Type

object (Crontab Configuration)

crontab Examples

{
  "dayOfMonth": "*",
  "dayOfWeek": "1-5",
  "hour": "9",
  "minute": "30",
  "month": "*",
  "second": "0",
  "timezone": "America/New_York"
}

description

Human-readable description of this scheduled job

description

• is required

• Type: string (Description)

• cannot be null

• defined in: Root Workflow

description Type

string (Description)

description Constraints

maximum length: the maximum number of characters for this string is: 500

minimum length: the minimum number of characters for this string is: 1

description Examples

"Daily backup of core routers"

enabled

Whether this scheduled job is active and should be executed

enabled

• is required

• Type: boolean (Enabled)

• cannot be null

• defined in: Root Workflow

enabled Type

boolean (Enabled)

enabled Examples

true

parameters

Key-value pairs of parameters that will be passed to the workflow execution

parameters

• is required

• Type: object (Execution Parameters)

• cannot be null

• defined in: Root Workflow

parameters Type

object (Execution Parameters)

parameters Constraints

minimum number of properties: the minimum number of properties for this object is: 1

parameters Examples

{
  "backupType": "full",
  "retentionDays": 7
}

query

Represents an Elasticsearch query in string format.

query

• is required

• Type: string (Elasticsearch Query)

• cannot be null

• defined in: Root Workflow

query Type

string (Elasticsearch Query)

query Examples

"device.hostname: *.lab"

title

Human-readable title for this scheduled job

title

• is required

• Type: string (Job Title)

• cannot be null

• defined in: Root Workflow

title Type

string (Job Title)

title Constraints

maximum length: the maximum number of characters for this string is: 100

minimum length: the minimum number of characters for this string is: 1

title Examples

"Daily Backup Job"