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

Create Cron Job

POST

/servers/{{serverId}}/cronjobs

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",
    "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 POST 'https://manage.runcloud.io/api/v3/servers/{{serverId}}/cronjobs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "label": "my first job",
    "username": "root",
    "command": "/bin/bash /root/clearitem.sh",
    "minute": "*",
    "hour": "*/2",
    "dayOfMonth": "*",
    "month": "*",
    "dayOfWeek": "*"
}'

Responses

🟢200Success

application/json

Body

integer

required

Cron job ID

label

string

required

Cron job label

username

string

required

User that will execute the cron job

time

string

required

Time which the cron job will execute at

command

string

required

Command

enabled

boolean

required

Status of cron job

created_at

string

required

Time which cron job was created at

Example

{
    "id": 35,
    "label": "my first job",
    "username": "root",
    "time": "* */2 * * *",
    "command": "/bin/bash /root/clearitem.sh",
    "enabled": 1,
    "created_at": "2024-07-18 06:27:19"
}

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

List Cron Jobs

Get Cron Job Object