List cronjobs of a web hosting package
The cronjobs of one web hosting package, with their last run and the package's limits.
manitu_webhosting_web_cronjob_list on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Lists the cronjobs of a web hosting package of the manitu customer account this connection works in, by its site_id from manitu_webhosting_list: for each what it runs (task: type with command, url or script_path), when (schedule as a cron expression in Europe/Berlin, next_run_at), whether and how it reports, and its last run (exit code, when, how long). The package's limits: count_max cronjobs, runs_per_hour_max runs per hour each, runtime_seconds_max per run (then it is stopped), and the PHP versions for php_script. What a run wrote: manitu_webhosting_web_cronjob_get.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
Result structuredContent, checked against the schema
cronjob_listarray of objectrequiredcronjob_list[].cronjob_idintegerrequiredThe cronjob - what the other cronjob tools take.
cronjob_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
cronjob_list[].statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
cronjob_list[].taskobjectrequiredWhat it runs - type, and only the field(s) that type uses.
cronjob_list[].task.typestring | nullrequiredcommand (a shell command), url (calls a URL), php_script (a PHP file of the package).
cronjob_list[].task.commandstring | nullFor type command: the shell command - runs as the package's user, in its root directory.
cronjob_list[].task.urlstring | nullFor type url: the URL called.
cronjob_list[].task.script_pathstring | nullFor type php_script: the PHP file, relative to the package.
cronjob_list[].task.php_versionstring | nullFor type php_script: the PHP version (e.g. "php8.3"); null: the package's default.
cronjob_list[].schedulestring | nullrequiredWhen it runs - a cron expression (minute hour day-of-month month day-of-week), in Europe/Berlin. null only if what is stored cannot be read.
cronjob_list[].schedule_typestring | nullrequiredHow the customer panel shows the schedule: minutely, hourly, daily, weekly, monthly, yearly, or crontab (anything else).
cronjob_list[].runs_per_hour_maxinteger | nullrequiredHow often it runs in one hour at most.
cronjob_list[].next_run_atstring | nullrequiredWhen it runs next; null if inactive or never.
cronjob_list[].reportobjectrequiredWhom it tells about a run, and how.
cronjob_list[].report.reasonstring | nullrequiredWhen the customer is told about a run: never, onerror (exit code not 0), always.
cronjob_list[].report.typestring | nullrequiredHow: mail, or logfile (a line in logs/cron.log of the package).
cronjob_list[].report.mailobject | nullrequiredThe report mail - null unless type is mail.
cronjob_list[].report.mail.recipientstring | nullrequiredWho gets the report mail.
cronjob_list[].report.mail.subjectstring | nullrequiredIts subject, with placeholders.
cronjob_list[].report.mail.bodystring | nullrequiredIts text, with placeholders.
cronjob_list[].last_runobject | nullrequiredIts last run; null if it has not run yet.
cronjob_list[].last_run.exit_codeinteger | nullrequiredIts exit code - 0 is success, 127 "command not found"; a run stopped at the time limit often shows 9 or 137.
cronjob_list[].last_run.started_atstring | nullrequiredWhen it started.
cronjob_list[].last_run.ended_atstring | nullrequiredWhen it ended.
cronjob_list[].last_run.duration_secondsnumber | nullrequiredHow long it ran.
cronjob_list[].created_atstring | nullrequiredWhen it was created.
count_maxinteger | nullrequiredHow many cronjobs the package allows.
runs_per_hour_maxintegerrequiredHow often a cronjob may run in one hour at most.
runtime_seconds_maxintegerrequiredHow long a run may take - then it is stopped.
php_version_listarray of objectrequiredThe PHP versions a php_script may run with.
php_version_list[].namestringrequiredWhat php_version takes, e.g. "php8.3".
php_version_list[].is_defaultbooleanrequiredThe package's default - used when php_version is null.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
Response in data; the rest of the body as on every call
cronjob_listarray of objectrequiredcronjob_list[].cronjob_idintegerrequiredThe cronjob - what the other cronjob tools take.
cronjob_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
cronjob_list[].statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
cronjob_list[].taskobjectrequiredWhat it runs - type, and only the field(s) that type uses.
cronjob_list[].task.typestring | nullrequiredcommand (a shell command), url (calls a URL), php_script (a PHP file of the package).
cronjob_list[].task.commandstring | nullFor type command: the shell command - runs as the package's user, in its root directory.
cronjob_list[].task.urlstring | nullFor type url: the URL called.
cronjob_list[].task.script_pathstring | nullFor type php_script: the PHP file, relative to the package.
cronjob_list[].task.php_versionstring | nullFor type php_script: the PHP version (e.g. "php8.3"); null: the package's default.
cronjob_list[].schedulestring | nullrequiredWhen it runs - a cron expression (minute hour day-of-month month day-of-week), in Europe/Berlin. null only if what is stored cannot be read.
cronjob_list[].schedule_typestring | nullrequiredHow the customer panel shows the schedule: minutely, hourly, daily, weekly, monthly, yearly, or crontab (anything else).
cronjob_list[].runs_per_hour_maxinteger | nullrequiredHow often it runs in one hour at most.
cronjob_list[].next_run_atstring | nullrequiredWhen it runs next; null if inactive or never.
cronjob_list[].reportobjectrequiredWhom it tells about a run, and how.
cronjob_list[].report.reasonstring | nullrequiredWhen the customer is told about a run: never, onerror (exit code not 0), always.
cronjob_list[].report.typestring | nullrequiredHow: mail, or logfile (a line in logs/cron.log of the package).
cronjob_list[].report.mailobject | nullrequiredThe report mail - null unless type is mail.
cronjob_list[].report.mail.recipientstring | nullrequiredWho gets the report mail.
cronjob_list[].report.mail.subjectstring | nullrequiredIts subject, with placeholders.
cronjob_list[].report.mail.bodystring | nullrequiredIts text, with placeholders.
cronjob_list[].last_runobject | nullrequiredIts last run; null if it has not run yet.
cronjob_list[].last_run.exit_codeinteger | nullrequiredIts exit code - 0 is success, 127 "command not found"; a run stopped at the time limit often shows 9 or 137.
cronjob_list[].last_run.started_atstring | nullrequiredWhen it started.
cronjob_list[].last_run.ended_atstring | nullrequiredWhen it ended.
cronjob_list[].last_run.duration_secondsnumber | nullrequiredHow long it ran.
cronjob_list[].created_atstring | nullrequiredWhen it was created.
count_maxinteger | nullrequiredHow many cronjobs the package allows.
runs_per_hour_maxintegerrequiredHow often a cronjob may run in one hour at most.
runtime_seconds_maxintegerrequiredHow long a run may take - then it is stopped.
php_version_listarray of objectrequiredThe PHP versions a php_script may run with.
php_version_list[].namestringrequiredWhat php_version takes, e.g. "php8.3".
php_version_list[].is_defaultbooleanrequiredThe package's default - used when php_version is null.
Statuses
200Success.400The request does not match the declared input schema.401No credential was presented, or it was not recognised.403The credential is not permitted to use this operation.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.