Show virtual server details
One vServer by id: status, power state, plan, hardware, network, rescue system, VNC, running workflows.
manitu_vserver_get on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Returns one virtual server (vServer) of the manitu customer account this connection works in, by its vserver_id from manitu_vserver_list (never guess one): description, hostname, status, power state (as manitu last saw it), plan and hardware, IPv4/IPv6 with gateway and reverse DNS, whether the rescue system and the VNC console are on, and the workflows still running on it (e.g. a reboot just asked for). For the operating systems it can be reinstalled with use manitu_vserver_product_get. Not found if the account has no such vServer; refused if this access may not see it.
Arguments
vserver_idinteger | stringrequiredThe vserver_id from manitu_vserver_list - never guess one.
Result structuredContent, checked against the schema
vserver_idintegerrequiredThe id of the vServer - what manitu_vserver_get and every route on it take (the same number as service_id).
service_idintegerrequiredThe id of the service instance - the same number as the id its own routes take (e.g. vserver_id).
service_typestringrequiredThe kind of service, e.g. vserver - its own data is under the key of that name.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
statusstringrequiredIts state as a service, e.g. active.
is_configurablebooleanrequiredIt can be changed right now - false e.g. while suspended.
planstring | nullrequiredThe plan, e.g. "vServer M".
plan_codestring | nullrequiredThe plan as a code, e.g. "vserver_server_m".
contract_idinteger | nullrequiredThe contract it runs under.
vserverobjectrequiredWhat is the vServer's own.
vserver.hostnamestring | nullrequiredIts hostname as manitu keeps it, if set.
vserver.power_statestring | nullrequirede.g. running or stopped - as manitu last saw it: updated with every workflow on the server and once a day, so a shutdown from inside the server may not show yet; null if unknown.
vserver.ipv4_addressstring | nullrequiredIts IPv4 address.
vserver.ipv6_addressstring | nullrequiredIts IPv6 address.
vserver.hardwareobjectrequiredWhat the plan comes with.
vserver.hardware.cpu_coresinteger | nullrequiredvserver.hardware.ram_gbinteger | nullrequiredvserver.hardware.disk_gbinteger | nullrequiredvserver.hardware.disk_typestring | nullrequirede.g. "SSD".
vserver.networkobjectrequiredvserver.network.ipv4object | nullrequiredvserver.network.ipv4.addressstring | nullrequiredvserver.network.ipv4.prefixinteger | nullrequiredvserver.network.ipv4.netmaskstring | nullrequiredIPv4 only.
vserver.network.ipv4.gatewaystring | nullrequiredvserver.network.ipv4.ptr_recordstring | nullrequiredThe reverse DNS name of the address.
vserver.network.ipv6object | nullrequiredvserver.network.ipv6.addressstring | nullrequiredvserver.network.ipv6.prefixinteger | nullrequiredvserver.network.ipv6.netmaskstring | nullrequiredIPv4 only.
vserver.network.ipv6.gatewaystring | nullrequiredvserver.network.ipv6.ptr_recordstring | nullrequiredThe reverse DNS name of the address.
vserver.rescue_system_enabledbooleanrequiredIt boots into manitu's rescue system instead of its own disk.
vserver.vnc_enabledbooleanrequiredThe VNC console is switched on.
pending_workflow_listarray of objectrequiredWorkflows on it that are still running, oldest first - e.g. a reboot just asked for.
pending_workflow_list[].workflowstringrequiredWhat is being done, e.g. a reboot.
pending_workflow_list[].workflow_idstringrequiredThe id of this run of the workflow.
pending_workflow_list[].created_atstring | nullrequiredWhen it was asked for.
pending_workflow_list[].started_atstring | nullrequiredWhen 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.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
vserver_idinteger | stringrequiredThe vserver_id from manitu_vserver_list - never guess one.
Response in data; the rest of the body as on every call
vserver_idintegerrequiredThe id of the vServer - what manitu_vserver_get and every route on it take (the same number as service_id).
service_idintegerrequiredThe id of the service instance - the same number as the id its own routes take (e.g. vserver_id).
service_typestringrequiredThe kind of service, e.g. vserver - its own data is under the key of that name.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
statusstringrequiredIts state as a service, e.g. active.
is_configurablebooleanrequiredIt can be changed right now - false e.g. while suspended.
planstring | nullrequiredThe plan, e.g. "vServer M".
plan_codestring | nullrequiredThe plan as a code, e.g. "vserver_server_m".
contract_idinteger | nullrequiredThe contract it runs under.
vserverobjectrequiredWhat is the vServer's own.
vserver.hostnamestring | nullrequiredIts hostname as manitu keeps it, if set.
vserver.power_statestring | nullrequirede.g. running or stopped - as manitu last saw it: updated with every workflow on the server and once a day, so a shutdown from inside the server may not show yet; null if unknown.
vserver.ipv4_addressstring | nullrequiredIts IPv4 address.
vserver.ipv6_addressstring | nullrequiredIts IPv6 address.
vserver.hardwareobjectrequiredWhat the plan comes with.
vserver.hardware.cpu_coresinteger | nullrequiredvserver.hardware.ram_gbinteger | nullrequiredvserver.hardware.disk_gbinteger | nullrequiredvserver.hardware.disk_typestring | nullrequirede.g. "SSD".
vserver.networkobjectrequiredvserver.network.ipv4object | nullrequiredvserver.network.ipv4.addressstring | nullrequiredvserver.network.ipv4.prefixinteger | nullrequiredvserver.network.ipv4.netmaskstring | nullrequiredIPv4 only.
vserver.network.ipv4.gatewaystring | nullrequiredvserver.network.ipv4.ptr_recordstring | nullrequiredThe reverse DNS name of the address.
vserver.network.ipv6object | nullrequiredvserver.network.ipv6.addressstring | nullrequiredvserver.network.ipv6.prefixinteger | nullrequiredvserver.network.ipv6.netmaskstring | nullrequiredIPv4 only.
vserver.network.ipv6.gatewaystring | nullrequiredvserver.network.ipv6.ptr_recordstring | nullrequiredThe reverse DNS name of the address.
vserver.rescue_system_enabledbooleanrequiredIt boots into manitu's rescue system instead of its own disk.
vserver.vnc_enabledbooleanrequiredThe VNC console is switched on.
pending_workflow_listarray of objectrequiredWorkflows on it that are still running, oldest first - e.g. a reboot just asked for.
pending_workflow_list[].workflowstringrequiredWhat is being done, e.g. a reboot.
pending_workflow_list[].workflow_idstringrequiredThe id of this run of the workflow.
pending_workflow_list[].created_atstring | nullrequiredWhen it was asked for.
pending_workflow_list[].started_atstring | nullrequiredWhen 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.
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.