SAF Documentation

@saflib/cron-spec

Interface: components ​

Properties ​

headers ​

headers: never

parameters ​

parameters: never

pathItems ​

pathItems: never

requestBodies ​

requestBodies: never

responses ​

responses: never

schemas ​

schemas: object

error ​

error: object

error.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

error.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.

job_settings ​

job_settings: object

job_settings.created_at? ​

readonly optional created_at: string

Format: date-time

Description ​

Timestamp when the job setting was created.

job_settings.enabled ​

enabled: boolean

Description ​

Whether the job is enabled to run.

job_settings.enabled_by? ​

optional enabled_by: null | string

Description ​

Kratos identity id of the admin who last enabled the job. Null for pre-migration rows until re-enabled. Ticks skip when enabled with null.

job_settings.id? ​

readonly optional id: number

Description ​

Unique identifier for the job setting.

job_settings.job_name ​

job_name: string

Description ​

The unique name of the cron job.

job_settings.last_run_at? ​

optional last_run_at: null | string

Format: date-time

Description ​

Timestamp of the last time the job ran.

job_settings.last_run_status? ​

optional last_run_status: null | "success" | "fail" | "running" | "timed out"

Description ​

Status of the last job run.

job_settings.runs_next_at? ​

readonly optional runs_next_at: null | string

Format: date-time

Description ​

Next scheduled tick when the job is enabled; null when disabled or schedule is unknown.

job_settings.schedule? ​

readonly optional schedule: null | string

Description ​

Cron schedule string from the registered JobsMap (e.g. */15 * * * *).

job_settings.updated_at? ​

readonly optional updated_at: string

Format: date-time

Description ​

Timestamp when the job setting was last updated.