This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

RunCloud

Update Cron Job

PATCH

/servers/{{serverId}}/cronjobs/{{cronJobId}}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

label

string

required

Name of cron job

username

string

required

System User that will be running this job

command

string

required

Full command of job to be running

minute

string

required

Crontab syntax for minute

hour

string

required

Crontab syntax for hour

dayOfMonth

string

required

Crontab syntax for the day of month

month

string

required

Crontab syntax for month

dayOfWeek

string

required

Crontab syntax for the day of week

Example

{
    "label": "my first job updated",
    "username": "root",
    "command": "/bin/bash /root/clearitem.sh",
    "minute": "*",
    "hour": "*/2",
    "dayOfMonth": "*",
    "month": "*",
    "dayOfWeek": "*"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH 'https://manage.runcloud.io/api/v3/servers/{{serverId}}/cronjobs/{{cronJobId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "label": "my first job updated",
    "username": "root",
    "command": "/bin/bash /root/clearitem.sh",
    "minute": "*",
    "hour": "*/2",
    "dayOfMonth": "*",
    "month": "*",
    "dayOfWeek": "*"
}'

Responses

🟢200Success

application/json

Body

message

string

required

Example

{
    "message": "cron job my first job updated via api successfully updated."
}

Modified at 2024-10-16 08:49:11

Get Cron Job Object

Toggle Cron Job (Enable/Disable)