Interface: paths
This file was auto-generated by openapi-typescript. Do not make direct changes to the file.
Properties
/cron/jobs
/cron/jobs:
object
delete?
optionaldelete:undefined
get
get:
object
List all cron jobs
get.parameters
parameters:
object
get.parameters.cookie?
optionalcookie:undefined
get.parameters.header?
optionalheader:undefined
get.parameters.path?
optionalpath:undefined
get.parameters.query?
optionalquery:undefined
get.requestBody?
optionalrequestBody:undefined
get.responses
responses:
object
get.responses.200
200:
object
Description
A list of cron jobs.
get.responses.200.content
content:
object
get.responses.200.content.application/json
application/json:
object[]
get.responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
get.responses.401
401:
object
Description
Unauthorized - Invalid or missing authentication.
get.responses.401.content
content:
object
get.responses.401.content.application/json
application/json:
object
get.responses.401.content.application/json.code?
optionalcode:string
Description
A short, machine-readable error code, for when HTTP status codes are not sufficient.
get.responses.401.content.application/json.message?
optionalmessage:string
Description
A human-readable description of the error.
Example
The requested resource could not be found.get.responses.401.headers
headers:
object
Index Signature
[name: string]: unknown
get.responses.403
403:
object
Description
Forbidden - Insufficient permissions (requires cron:read).
get.responses.403.content
content:
object
get.responses.403.content.application/json
application/json:
object
get.responses.403.content.application/json.code?
optionalcode:string
Description
A short, machine-readable error code, for when HTTP status codes are not sufficient.
get.responses.403.content.application/json.message?
optionalmessage:string
Description
A human-readable description of the error.
Example
The requested resource could not be found.get.responses.403.headers
headers:
object
Index Signature
[name: string]: unknown
head?
optionalhead:undefined
options?
optionaloptions:undefined
parameters
parameters:
object
parameters.cookie?
optionalcookie:undefined
parameters.header?
optionalheader:undefined
parameters.path?
optionalpath:undefined
parameters.query?
optionalquery:undefined
patch?
optionalpatch:undefined
post?
optionalpost:undefined
put?
optionalput:undefined
trace?
optionaltrace:undefined
/cron/jobs/settings
/cron/jobs/settings:
object
delete?
optionaldelete:undefined
get?
optionalget:undefined
head?
optionalhead:undefined
options?
optionaloptions:undefined
parameters
parameters:
object
parameters.cookie?
optionalcookie:undefined
parameters.header?
optionalheader:undefined
parameters.path?
optionalpath:undefined
parameters.query?
optionalquery:undefined
patch?
optionalpatch:undefined
post?
optionalpost:undefined
put
put:
object
Update settings for a specific cron job by name
put.parameters
parameters:
object
put.parameters.cookie?
optionalcookie:undefined
put.parameters.header?
optionalheader:undefined
put.parameters.path?
optionalpath:undefined
put.parameters.query?
optionalquery:undefined
put.requestBody
requestBody:
object
Description
The job name and settings to update.
put.requestBody.content
content:
object
put.requestBody.content.application/json
application/json:
object
put.requestBody.content.application/json.enabled
enabled:
boolean
Description
Set whether the job is enabled.
put.requestBody.content.application/json.job_name
job_name:
string
Description
The name of the job to update.
put.responses
responses:
object
put.responses.200
200:
object
Description
Job settings updated successfully.
put.responses.200.content
content:
object
put.responses.200.content.application/json
application/json:
object
put.responses.200.content.application/json.created_at?
readonlyoptionalcreated_at:string
Format: date-time
Description
Timestamp when the job setting was created.
put.responses.200.content.application/json.enabled
enabled:
boolean
Description
Whether the job is enabled to run.
put.responses.200.content.application/json.enabled_by?
optionalenabled_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.
put.responses.200.content.application/json.id?
readonlyoptionalid:number
Description
Unique identifier for the job setting.
put.responses.200.content.application/json.job_name
job_name:
string
Description
The unique name of the cron job.
put.responses.200.content.application/json.last_run_at?
optionallast_run_at:null|string
Format: date-time
Description
Timestamp of the last time the job ran.
put.responses.200.content.application/json.last_run_status?
optionallast_run_status:null|"success"|"fail"|"running"|"timed out"
Description
Status of the last job run.
put.responses.200.content.application/json.runs_next_at?
readonlyoptionalruns_next_at:null|string
Format: date-time
Description
Next scheduled tick when the job is enabled; null when disabled or schedule is unknown.
put.responses.200.content.application/json.schedule?
readonlyoptionalschedule:null|string
Description
Cron schedule string from the registered JobsMap (e.g. */15 * * * *).
put.responses.200.content.application/json.updated_at?
readonlyoptionalupdated_at:string
Format: date-time
Description
Timestamp when the job setting was last updated.
put.responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
put.responses.401
401:
object
Description
Unauthorized - Invalid or missing authentication.
put.responses.401.content
content:
object
put.responses.401.content.application/json
application/json:
object
put.responses.401.content.application/json.code?
optionalcode:string
Description
A short, machine-readable error code, for when HTTP status codes are not sufficient.
put.responses.401.content.application/json.message?
optionalmessage:string
Description
A human-readable description of the error.
Example
The requested resource could not be found.put.responses.401.headers
headers:
object
Index Signature
[name: string]: unknown
put.responses.403
403:
object
Description
Forbidden - Insufficient permissions (requires cron:write).
put.responses.403.content
content:
object
put.responses.403.content.application/json
application/json:
object
put.responses.403.content.application/json.code?
optionalcode:string
Description
A short, machine-readable error code, for when HTTP status codes are not sufficient.
put.responses.403.content.application/json.message?
optionalmessage:string
Description
A human-readable description of the error.
Example
The requested resource could not be found.put.responses.403.headers
headers:
object
Index Signature
[name: string]: unknown
put.responses.404
404:
object
Description
Job setting with the specified name not found.
put.responses.404.content
content:
object
put.responses.404.content.application/json
application/json:
object
put.responses.404.content.application/json.code?
optionalcode:string
Description
A short, machine-readable error code, for when HTTP status codes are not sufficient.
put.responses.404.content.application/json.message?
optionalmessage:string
Description
A human-readable description of the error.
Example
The requested resource could not be found.put.responses.404.headers
headers:
object
Index Signature
[name: string]: unknown
trace?
optionaltrace:undefined