cron_*

The following functions are for listing, retrieving, creating, updating, and deleting your cronjobs.

All parameters are listed in the table. Required parameters are in bold with no default values.

cron_list

List cronjobs under your account, up to 1000 items per page.

Name	Type	Default	Description
token	string		Your API token
page	int	1	Page number
keyword	string	null	Keyword to search cronjobs (name, ID, URL)

Returns an array of cronjob data structures.

cron_get

Get a cronjob data.

Name	Type	Description
token	string	Your API token
id	integer	Cronjob ID

Returns the cronjob data like this:

{"data":{"id":132,"group":null,"expression":"41 3 * * 2","timezone":"Europe\/London","url":"http:\/\/example.com\/cron_php","postData":"","fail":0,"status":0,"name":"weekly","notify":true,"points":1},"status":"success","code":0}

cron_add

Add a new cronjob.

Name	Type	Default	Description
token	string		Your API token
url	string		URL to call
expression	string	1 hour	Time expression, may be either crontab syntax or time interval in English
timezone	string	account timezone	Cronjob timezone
timeout	integer	plan timeout	Cron timeout - max time to wait for your URL to response.
instances	integer	0	Max overlapping cronjob executions: 0: unlimited, 1: single, 2 - 5: 2 - 5 overlapping executions
username	string	null	Username for HTTP authentication
password	string	null	Password for HTTP authentication
httpMethod	string	GET	HTTP method of the HTTP request to send to your cronjob URL
postData	string	null	When httpMethod is POST or PUT, send this post data with the HTTP request.
httpHeaders	string	null	Plain HTTP headers to send to your cronjob URL. Use new lines as delimiters, e.g.
notify	bool	true	Enable notification on failure.
notifyEvery	int	1	When notify is true, send notification every notifyEvery fails.
ignoreHttpStatus	bool	true	True to not check your cron execution’s HTTP result.
retryFailed	bool	true	True to allow to keep trying failed cronjob.
failureThreshold	integer	10	Number of failures allowed before we disable your failed cronjob.
pattern	string	null	If the cron execution contains the string, mark it as failure
group	integer	null	Group ID
name	string	null	Name of cronjob

Returns the newly created cronjob.

https://app.fastcron.com/api/v1/cron_add?token=******&expression=*/3 1,2,3 * * *&url=example.com/cron_php

{"data":{"id":132,"group":null,"expression":"*/3 1,2,3 * * *","timezone":"UTC","url":"http:\/\/example.com\/cron_php","postData":"","fail":0,"status":0,"name":"","notify":true,"points":9},"status":"success","code":0}

cron_edit

Update an existing cronjob

Name	Type	Default	Description
token	string		Your API token
id	integer		Cronjob ID
any	any	current value	Any parameter listed in cron_add parameters

Similar to cron_add, except that it’ll update a specific cronjob with provided ID.

Returns the structure of the updated cronjob.

cron_enable

Enable a cronjob

Name	Type	Description
token	string	Your API token
id	integer	Cronjob ID

Returns the structure of the updated cronjob.

cron_disable

Disable a cronjob

Name	Type	Description
token	string	Your API token
id	integer	Cronjob ID

Returns the structure of the updated cronjob.

cron_pause

Pause a cronjob for a specific duration

Name	Type	Default	Description
token	string		Your API token
id	integer		Cronjob ID
for	string	null	An expression for time modification e.g. 15 minutes, 1 hour, 1 day, etc.

Returns the structure of the paused cronjob.

cron_delete

Delete a cronjob

Name	Type	Description
token	string	Your API token
id	integer	Cronjob ID

Returns the structure of the deleted cronjob, with ID set to null.

cron_run

Schedule the cronjob to run within next minute. This doesn’t change the cronjob time settings.

Name	Type	Description
token	string	Your API token
id	integer	Cronjob ID

Returns the timestamp which cronjob will run at.

cron_logs

Get your cronjob execution logs.

Name	Type	Description
token	string	Your API token
id	integer	Cronjob ID

Returns an array of cron execution results.

cron_failures

Get your cronjobs failed execution logs.

Name	Type	Default	Description
token	string		Your API token
id	integer	null	Cronjob ID

Returns an array of cron execution results data structures.

If no id is provided, it will return an array of all cronjobs failure logs.

cron_batch_add

Add multiple cronjobs at once/

Name	Type	Default	Description
token	string	null	Your API token
data	array	null	Array of cron_add parameters except token.

This works only with requests in JSON format like this:

curl -X POST "https://app.fastcron.com/api/v1/cron_batch_add" \
-H 'Content-Type: application/json' \
-d '{"token":"***", "data":[{"url":"https://example.com", "expression":"1 hour"},{"url":"https://example.com", "expression":"1 day"}]}'

Returns an array of cronjob data structures.

cron_batch_edit

Update multiple cronjobs at once.

Name	Type	Default	Description
token	string		Your API token
id	array		List of cronjob IDs
any	any	current values	Any parameters listed in cron_add parameters except token

Returns an array of updated cronjob data structures.

cron_batch_delete

Delete multiple cronjobs at once.

Name	Type	Description
token	string	Your API token
id	array	List of cronjob IDs

Returns an array of deleted cronjobs.

cron_group_edit

Update multiple cronjobs in a group at once.

Name	Type	Default	Description
token	string		Your API token
id	int		The group ID
any	null	existing value	Any parameter listed in cron_add parameters except token

Returns an array of updated cronjob data structures.