<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/scheduled-jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My scheduled job',
'command' => 'echo $(whoami)',
'user' => 'root',
'frequency' => 'hourly',
'cron' => '0 * * * *',
'heartbeat' => null,
'grace_period' => '5'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"data": {
"id": "<string>",
"type": "scheduledJobs",
"attributes": {
"name": "<string>",
"command": "<string>",
"status": "<string>",
"user": "<string>",
"frequency": "<string>",
"cron": "<string>",
"next_run_time": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
}
}
}
Create a specific scheduled job.
Processing mode: async
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/scheduled-jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My scheduled job',
'command' => 'echo $(whoami)',
'user' => 'root',
'frequency' => 'hourly',
'cron' => '0 * * * *',
'heartbeat' => null,
'grace_period' => '5'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"data": {
"id": "<string>",
"type": "scheduledJobs",
"attributes": {
"name": "<string>",
"command": "<string>",
"status": "<string>",
"user": "<string>",
"frequency": "<string>",
"cron": "<string>",
"next_run_time": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"links": {
"self": {
"href": "<string>",
"rel": "<string>",
"describedby": "<string>",
"title": "<string>",
"type": "<string>",
"hreflang": "<string>",
"meta": {}
}
}
}
}
The access token received from the authorization server in the OAuth 2.0 flow.
JobResource
The response is of type object
.
Was this page helpful?