Take snapshot of a virtual server

Take a snapshot of one vServer, with an optional note.

WWriteNot idempotentbetaNeeds service_vserver
Tool
manitu_vserver_snapshot_createon https://mcp.manitu.de/mcp
POST
/v1/vserver/snapshot/createon https://api.manitu.de
Try it
Changes the account. Agents say what will happen and wait for an explicit yes before calling it.
readOnlyHint falsedestructiveHint falseidempotentHint falseopenWorldHint false

Takes a snapshot of a virtual server (vServer), by its vserver_id from manitu_vserver_list - a state to go back to later with manitu_vserver_snapshot_revert, e.g. before an update. Snapshots expire and are deleted automatically (see manitu_vserver_snapshot_list). Not a backup for a reinstall: manitu_vserver_reinstall deletes all snapshots of the server along with its data - data that must survive a reinstall has to be copied elsewhere first. Runs in the background: the answer is the workflow started (see pending_workflow_list of manitu_vserver_get for its progress). Refused with a conflict when the server has as many snapshots as it may (limit_reached - one has to be deleted first), while another workflow runs on it, or while it cannot be changed.

vserver_idinteger | stringrequired

The vserver_id from manitu_vserver_list - never guess one.

pattern ^[1-9][0-9]*$min 1
descriptionstring | null

A note on the snapshot, e.g. "before the PHP update". Left out: unchanged (set) or none (create); null or empty: none.

max length 255
workflowstringrequired

What is being done, e.g. a reboot.

One of create destroy power_start power_stop power_reboot reinstall ptr_set vnc_enable vnc_disable rescuesystem_enable rescuesystem_disable snapshot_create snapshot_delete snapshot_delete_all snapshot_revert telemetry_await iso_eject
workflow_idstringrequired

The id of this run of the workflow.

created_atstring | nullrequired

When it was asked for.

Format date-time
started_atstring | nullrequired

When it started; null while it waits for the next run - usually a minute or two, at times longer. Nothing to tell the customer unless asked.

Format date-time
workflow_tokenstring | nullrequired

Pass it to manitu_workflow_get to see how far the workflow is - as it is, never built or changed. A secret of this workflow: do not show it to anyone. null if there is none.

taskobjectrequired

The task the customer panel polls for its progress.

task.idintegerrequired
task.authstringrequired

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

vserver_idinteger | stringrequired

The vserver_id from manitu_vserver_list - never guess one.

pattern ^[1-9][0-9]*$min 1
descriptionstring | null

A note on the snapshot, e.g. "before the PHP update". Left out: unchanged (set) or none (create); null or empty: none.

max length 255
workflowstringrequired

What is being done, e.g. a reboot.

One of create destroy power_start power_stop power_reboot reinstall ptr_set vnc_enable vnc_disable rescuesystem_enable rescuesystem_disable snapshot_create snapshot_delete snapshot_delete_all snapshot_revert telemetry_await iso_eject
workflow_idstringrequired

The id of this run of the workflow.

created_atstring | nullrequired

When it was asked for.

Format date-time
started_atstring | nullrequired

When it started; null while it waits for the next run - usually a minute or two, at times longer. Nothing to tell the customer unless asked.

Format date-time
workflow_tokenstring | nullrequired

Pass it to manitu_workflow_get to see how far the workflow is - as it is, never built or changed. A secret of this workflow: do not show it to anyone. null if there is none.

taskobjectrequired

The task the customer panel polls for its progress.

task.idintegerrequired
task.authstringrequired
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.