cronjob.create

Create a new cron job.

stderr and stdout are boolean values which if true, represent that we would like to suppress standard error / standard output respectively.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Cron job configuration data for the new job.

 No Additional Properties

Enabled

Type: boolean Default: true

Whether the cron job is active and will be executed.

Stderr

Type: boolean Default: false

Whether to redirect standard error output to email.

Stdout

Type: boolean Default: true

Whether to redirect standard output to email.

CronJobSchedule

Type: object
Default:
{ "minute": "00", "hour": "*", "dom": "*", "month": "*", "dow": "*" }

Cron schedule configuration for when the job runs.

 No Additional Properties

Minute

Type: string Default: "00"

"00" - "59"

Hour

Type: string Default: "*"

"00" - "23"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

"1" (January) - "12" (December)

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

Command

Type: string

Shell command or script to execute.

Description

Type: string Default: ""

Human-readable description of what this cron job does.

User

Type: string

System user account to run the command as.

CronJobEntry

Type: object

The created cron job configuration.

 No Additional Properties

Enabled

Type: boolean Default: true

Whether the cron job is active and will be executed.

Stderr

Type: boolean Default: false

Whether to redirect standard error output to email.

Stdout

Type: boolean Default: true

Whether to redirect standard output to email.

CronJobSchedule

Type: object
Default:
{ "minute": "00", "hour": "*", "dom": "*", "month": "*", "dow": "*" }

Cron schedule configuration for when the job runs.

 No Additional Properties

Minute

Type: string Default: "00"

"00" - "59"

Hour

Type: string Default: "*"

"00" - "23"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

"1" (January) - "12" (December)

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

Command

Type: string

Shell command or script to execute.

Description

Type: string Default: ""

Human-readable description of what this cron job does.

User

Type: string

System user account to run the command as.

Id

Type: integer

Unique identifier for the cron job.


Required roles: SYSTEM_CRON_WRITE