Preview cron
POST
/api/automation/rules/cron-previewAdministrator
A schedule and a reminder take only the actions that tell people something — Slack, email, and Microsoft Teams: nobody is watching when they go off. A schedule takes its project from the release it repeats. Preview next run on the page, or POST /api/automation/rules/cron-preview, says when an expression would next fire before any rule keeps it.
Request body
application/json
| Field | Type | Required | Notes |
|---|---|---|---|
cronExpression | string | Required | |
cronTimeZone | string | Required |
Response
Success: 200
| Field | Type | Required | Notes |
|---|---|---|---|
nextFireAt | string (date-time) | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | malformed_requestthe body cannot be read | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
403 | access_deniedan administrator endpoint, or a missing or stale CSRF token | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400, 404, 409 | See the guide | Automation area |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/automation/rules/cron-preview" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"cronExpression": "<string>",
"cronTimeZone": "<string>"
}'
The request body is an example built from the schema; replace every placeholder.
Response
200Example
{
"nextFireAt": "<date-time>"
}