Check a schedule or a command
Checks a schedule, a command or both, and answers when the schedule would next run, any warnings and anything refused. Nothing is saved.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
Checked against the same rules as a saved command, including its 500 character limit. Up to 20,000 characters.
Up to 200 characters.
Returns
200 The result of the check. A schedule or command that is refused answers 200 with valid false.
Fields of the 200 answer
What was refused, keyed by the schedule field (minute, hour and so on) or command. An empty object when nothing was.
The schedule in words. Null when no valid schedule was sent.
The next three runs.
The schedule as it would be saved.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
409 | deleted | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
409 | provisioning | The site is still being created. Try again in a few minutes. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/crons/validate \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"command": "php bin/console app:export",
"schedule": "30 2 * * *"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/crons/validate', [
'command' => 'php bin/console app:export',
'schedule' => '30 2 * * *',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/crons/validate', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
command: 'php bin/console app:export',
schedule: '30 2 * * *',
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/corestack/sites/1042/crons/validate",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"command": "php bin/console app:export",
"schedule": "30 2 * * *",
},
)
data = res.json() if res.content else None{
"errors": {
"command": "Command contains `sudo`, which is not allowed in a cron",
"minute": "Minute must be 0–59"
},
"human": null,
"next_runs": [],
"normalised": null,
"valid": false,
"warnings": []
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "deleted",
"message": "This site is deleted and waiting to be purged. Restore it first.",
"reason": "deleted"
}{
"code": "invalid",
"errors": {
"schedule": [
"Send a schedule or a command to check"
]
},
"field": "schedule",
"message": "Send a schedule or a command to check",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}