Automation

Update a cron job's command, schedule, container or enabled state

patch/projects/{projectId}/cron/{cronJobId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/projects/{projectId}/cron/{cronJobId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

projectIdstring uuid required
Example:3f2b8a4e-5c1d-4e8f-9a7b-2c6d1e0f4a5b
cronJobIdstring uuid required
Example:3f2b8a4e-5c1d-4e8f-9a7b-2c6d1e0f4a5b

Request body

namestring
commandstring
schedulestring

standard 5-field cron expression: "minute hour day-of-month month day-of-week", e.g. "0 3 * * *" for daily at 03:00 UTC

containerstring nullable
enabledboolean

Response

Updated

idstring uuid required
namestring required
commandstring required
schedulestring required

standard 5-field cron expression: "minute hour day-of-month month day-of-week", e.g. "0 3 * * *" for daily at 03:00 UTC

containerstring nullable required

null = the project's main container

enabledboolean required
lastStatus'success' | 'failed' | 'null' nullable required
lastRunAtstring nullable required

ISO-8601 timestamp

lastDurationMsinteger nullable required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.