Show SSH user of a web hosting package
One SSH user of a web hosting package, with its keys and how to connect.
manitu_webhosting_web_sshuser_get on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Returns one SSH user of a web hosting package of the manitu customer account this connection works in, by site_id and username from manitu_webhosting_web_sshuser_list: status, whether it can log in now, when it expires, shell, disk space limit, its public keys (read live from the server - with fingerprint and comment; has_options or is_valid false marks a line the customer wrote himself on the server), and connection: host, user name, SSH on port 22, public key only, and the server's host key fingerprints - what the customer's SSH client shows on the first connection must match one of them. An SSH user reaches the whole package.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
usernamestringrequiredThe user name of the SSH user (ssh<number>) from manitu_webhosting_web_sshuser_list - never guess one.
Result structuredContent, checked against the schema
usernamestringrequiredThe user name to log in with (ssh<number>) - what the other SSH user tools take.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
is_usable_nowbooleanrequiredIt can log in right now: active and not expired.
expires_atstring | nullrequiredWhen the SSH user expires. From this moment on it can no longer be used (the moment itself is excluded); null: without end.
shellstring | nullrequiredThe shell: bash, zsh, or git (git only - for pushing and pulling repositories).
quota_mbinteger | nullrequiredDisk space in MB the files it owns may take; null: no limit of its own (the package's applies).
created_atstring | nullrequiredWhen it was created.
last_login_atstring | nullrequiredIts last login, null if never.
ssh_key_listarray of object | nullrequiredThe public keys that may log in, read live from the server (the customer may change them there himself); null if the file could not be read.
ssh_key_list[].linestringrequiredThe line as it is in the file - a public key, no secret.
ssh_key_list[].algorithmstring | nullrequirede.g. ssh-ed25519; null if the line is no key.
ssh_key_list[].commentstring | nullrequiredThe comment after the key - often who it belongs to.
ssh_key_list[].fingerprint_sha256string | nullrequiredAs "ssh-keygen -lf" shows it, e.g. "SHA256:...".
ssh_key_list[].has_optionsbooleanrequiredOptions in front of the key (command=, from= ...) - written by the customer on the server.
ssh_key_list[].is_validbooleanrequiredA line manitu would write itself; false: kept only as long as the file is not replaced.
connectionobjectrequiredconnection.hoststring | nullrequiredThe host to connect to - the web server of the package.
connection.usernamestringrequiredThe user name to log in with.
connection.method_listarray of objectrequiredThe ways to connect: SSH on port 22.
connection.method_list[].protocolstringrequiredconnection.method_list[].portintegerrequiredconnection.method_list[].is_encryptedbooleanrequiredconnection.method_list[].is_recommendedbooleanrequiredconnection.authstringrequiredpublic_key_only: log in with a key from the user's ssh_key_list - a password does not work.
connection.host_key_listarray of objectrequiredThe server's host keys - on the first connection the SSH client shows one of these fingerprints; it must match.
connection.host_key_list[].algorithmstringrequiredconnection.host_key_list[].fingerprint_sha256stringrequiredAs the SSH client shows it, e.g. "SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8".
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.
usernamestringrequiredThe user name of the SSH user (ssh<number>) from manitu_webhosting_web_sshuser_list - never guess one.
Response in data; the rest of the body as on every call
usernamestringrequiredThe user name to log in with (ssh<number>) - what the other SSH user tools take.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
is_usable_nowbooleanrequiredIt can log in right now: active and not expired.
expires_atstring | nullrequiredWhen the SSH user expires. From this moment on it can no longer be used (the moment itself is excluded); null: without end.
shellstring | nullrequiredThe shell: bash, zsh, or git (git only - for pushing and pulling repositories).
quota_mbinteger | nullrequiredDisk space in MB the files it owns may take; null: no limit of its own (the package's applies).
created_atstring | nullrequiredWhen it was created.
last_login_atstring | nullrequiredIts last login, null if never.
ssh_key_listarray of object | nullrequiredThe public keys that may log in, read live from the server (the customer may change them there himself); null if the file could not be read.
ssh_key_list[].linestringrequiredThe line as it is in the file - a public key, no secret.
ssh_key_list[].algorithmstring | nullrequirede.g. ssh-ed25519; null if the line is no key.
ssh_key_list[].commentstring | nullrequiredThe comment after the key - often who it belongs to.
ssh_key_list[].fingerprint_sha256string | nullrequiredAs "ssh-keygen -lf" shows it, e.g. "SHA256:...".
ssh_key_list[].has_optionsbooleanrequiredOptions in front of the key (command=, from= ...) - written by the customer on the server.
ssh_key_list[].is_validbooleanrequiredA line manitu would write itself; false: kept only as long as the file is not replaced.
connectionobjectrequiredconnection.hoststring | nullrequiredThe host to connect to - the web server of the package.
connection.usernamestringrequiredThe user name to log in with.
connection.method_listarray of objectrequiredThe ways to connect: SSH on port 22.
connection.method_list[].protocolstringrequiredconnection.method_list[].portintegerrequiredconnection.method_list[].is_encryptedbooleanrequiredconnection.method_list[].is_recommendedbooleanrequiredconnection.authstringrequiredpublic_key_only: log in with a key from the user's ssh_key_list - a password does not work.
connection.host_key_listarray of objectrequiredThe server's host keys - on the first connection the SSH client shows one of these fingerprints; it must match.
connection.host_key_list[].algorithmstringrequiredconnection.host_key_list[].fingerprint_sha256stringrequiredAs the SSH client shows it, e.g. "SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8".
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.