Change description and hostname of a virtual server
The description and hostname manitu keeps for a vServer – nothing on the server itself changes.
manitu_vserver_set on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Changes the description and/or hostname manitu keeps for a virtual server (vServer), by its vserver_id from manitu_vserver_list - what the customer panel and manitu_vserver_list show. It does not change anything on the server itself (not its operating system's hostname, not its reverse DNS - that is manitu_vserver_ptr_set). Answers the vServer as changed. A hostname that is none is refused.
Provide at least one of: description, hostname.
Arguments
vserver_idinteger | stringrequiredThe vserver_id from manitu_vserver_list - never guess one.
descriptionstring | nullThe customer's description of it, e.g. "shop, production". Left out: unchanged (set) or none (create); null or empty: none.
hostnamestring | nullIts hostname, e.g. "web1.example.com". Left out: unchanged (set) or none (create); null or empty: none.
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".
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.
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.
descriptionstring | nullThe customer's description of it, e.g. "shop, production". Left out: unchanged (set) or none (create); null or empty: none.
hostnamestring | nullIts hostname, e.g. "web1.example.com". Left out: unchanged (set) or none (create); null or empty: none.
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".
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.
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.