Show progress of a job

How far a job is that another route started, by its job_token.

Returns the status of a background job of the account - a restart or snapshot of a virtual server, a database copy and the like - by the job_token the route that started it answered (job_token_malformed if it is not one). status pending or running: not finished yet; succeeded: finished; failed: it failed, result.error_list may say why. result holds what the job left once finished - an installed application's administrator and where to log in, the versions of an update. Refused when the access may not see the package or server the job works on (permission_missing, primary_access_required), and when there is no such job (resource_not_found). Changes nothing.

RReadIdempotent
Tool
manitu_job_geton https://mcp.manitu.de/mcp
POST
/v1/job/geton https://api.manitu.de
Try it
readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

Shows the status of a background job (how far it is) that a manitu tool started in the manitu customer account this connection works in - a restart or snapshot of a virtual server, a database copy and the like - by the job_token that tool answered, passed as it is. status pending or running: not finished yet - wait and ask again, not more often than about once a minute; some take many minutes. succeeded: finished. failed: it failed - tell the user, do not simply start it again (result.error_list may say why). result has what it left for the user once finished - an installed application's administrator and where to log in, the versions of an update. Refused (forbidden) when this access may not see the package or server the job works on. The token is a secret of this job: never show it.

Reasons it may answer: resource_not_found, permission_missing, primary_access_required, job_token_malformed.

job_token (required)stringwrite-only

The job_token the starting tool answered - passed as it is, never built.

min length 1max length 255
kindstring | null

What is being done, a lower_snake_case code of the backend, e.g. power_reboot - its values are the backend's own, an open set. null where the backend does not name it.

One of vserver_create vserver_delete power_start power_stop power_reboot reinstall ptr_set vnc_enable vnc_disable rescue_system_enable rescue_system_disable snapshot_create snapshot_delete snapshot_delete_all snapshot_revert setup_finish iso_eject contract_termination application_install application_update permission_set database_copy network_discovery null pattern ^[a-z0-9]+(_[a-z0-9]+)*$
job_idstring | nulloptional

The id of this run, where the backend keeps one; null otherwise.

statusany

pending: waiting to start; running: started, not finished; succeeded: finished, everything went through; failed: finished, but it or part of it failed. cancelled is reserved and not sent.

One of pending running succeeded failed
created_atstring | null

When it was asked for.

Format date-time
started_atstring | nulloptional

When it started; null while pending, and where the backend does not record it.

Format date-time
ended_atstring | nulloptional

When it finished; null until then.

Format date-time
updated_atstring | nulloptional

When it last changed.

Format date-time
job_tokenstring | null

What the operation that follows a job takes to find this one - passed as it is, never built or changed. A secret of this job: not to be shown to anyone. null where there is none.

min length 1
resultobject | null

What it left for the user, when it is finished - null for a job that keeps none.

result.adminobject | null

The administrator of an application manitu installed.

result.admin.usernamestring
result.admin.passwordstring | null

A secret; null where it is withheld (secrets_withheld).

result.admin.mail_addressstring
result.administration_urlstring | null

Where an installed application is administered.

result.versionobject | null

The versions of an application update.

result.version.oldstring | null
result.version.newstring | null
result.dumpobject | null

The dump files a database copy wrote, relative to the package.

result.dump.sourcestring | null
result.dump.targetstring | null
result.error_listarray of string

Why it failed, as codes - e.g. quota_exceeded, extra_files_found, nextcloud_too_old.

secrets_withheldboolean

A secret in result is left out here (an answer to an agent).

One of X-API-Key, Authorization: Bearer … - never more than one in a request. More

job_token (required)stringwrite-only

The job_token the starting tool answered - passed as it is, never built.

min length 1max length 255
kindstring | null

What is being done, a lower_snake_case code of the backend, e.g. power_reboot - its values are the backend's own, an open set. null where the backend does not name it.

One of vserver_create vserver_delete power_start power_stop power_reboot reinstall ptr_set vnc_enable vnc_disable rescue_system_enable rescue_system_disable snapshot_create snapshot_delete snapshot_delete_all snapshot_revert setup_finish iso_eject contract_termination application_install application_update permission_set database_copy network_discovery null pattern ^[a-z0-9]+(_[a-z0-9]+)*$
job_idstring | nulloptional

The id of this run, where the backend keeps one; null otherwise.

statusany

pending: waiting to start; running: started, not finished; succeeded: finished, everything went through; failed: finished, but it or part of it failed. cancelled is reserved and not sent.

One of pending running succeeded failed
created_atstring | null

When it was asked for.

Format date-time
started_atstring | nulloptional

When it started; null while pending, and where the backend does not record it.

Format date-time
ended_atstring | nulloptional

When it finished; null until then.

Format date-time
updated_atstring | nulloptional

When it last changed.

Format date-time
job_tokenstring | null

What the operation that follows a job takes to find this one - passed as it is, never built or changed. A secret of this job: not to be shown to anyone. null where there is none.

min length 1
resultobject | null

What it left for the user, when it is finished - null for a job that keeps none.

result.adminobject | null

The administrator of an application manitu installed.

result.admin.usernamestring
result.admin.passwordstring | null

A secret; null where it is withheld (secrets_withheld).

result.admin.mail_addressstring
result.administration_urlstring | null

Where an installed application is administered.

result.versionobject | null

The versions of an application update.

result.version.oldstring | null
result.version.newstring | null
result.dumpobject | null

The dump files a database copy wrote, relative to the package.

result.dump.sourcestring | null
result.dump.targetstring | null
result.error_listarray of string

Why it failed, as codes - e.g. quota_exceeded, extra_files_found, nextcloud_too_old.

secrets_withheldboolean

A secret in result is left out here (an answer to an agent).

200Success.400The input is wrong, or the request itself (INVALID_INPUT). Each entry names its field and its reason - correct the input and call again.401No credential was presented, or it was not recognised (UNAUTHENTICATED).403The credential is valid, but may not do this (PERMISSION_DENIED). The reason says why - another credential is the way, not a repeat.404What the call names does not exist, or not for this caller (NOT_FOUND). Look it up again - do not guess another.429Too many calls. The Retry-After header says when to try again.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.
resource_not_foundWhat the call names does not exist in the account, or not for this access.NOT_FOUNDpermission_missingThis access lacks a permission the call needs; the main access of the account can grant it.PERMISSION_DENIEDprimary_access_requiredOnly the main access of the account may see this job.PERMISSION_DENIEDjob_token_malformedThe job_token is none - pass it as the starting tool answered it.INVALID_INPUT
Example