List SSH users of a web hosting package
The SSH users of one web hosting package, with how to connect.
manitu_webhosting_web_sshuser_list on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Lists the SSH users of a web hosting package of the manitu customer account this connection works in, by its site_id from manitu_webhosting_list: for each its username, description, status, whether it can log in now, when it expires, shell and disk space limit. Login is by public key only; the keys of one user are in manitu_webhosting_web_sshuser_get. connection says how to connect (SSH on port 22, the server's host key fingerprints). An SSH user reaches the whole package. count_max is how many SSH users the package allows.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
Result structuredContent, checked against the schema
ssh_user_listarray of objectrequiredssh_user_list[].usernamestringrequiredThe user name to log in with (ssh<number>) - what the other SSH user tools take.
ssh_user_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
ssh_user_list[].statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
ssh_user_list[].is_usable_nowbooleanrequiredIt can log in right now: active and not expired.
ssh_user_list[].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.
ssh_user_list[].shellstring | nullrequiredThe shell: bash, zsh, or git (git only - for pushing and pulling repositories).
ssh_user_list[].quota_mbinteger | nullrequiredDisk space in MB the files it owns may take; null: no limit of its own (the package's applies).
ssh_user_list[].created_atstring | nullrequiredWhen it was created.
ssh_user_list[].last_login_atstring | nullrequiredIts last login, null if never.
count_maxinteger | nullrequiredHow many SSH users the package allows.
connectionobjectrequiredconnection.hoststring | nullrequiredThe host to connect to - the web server of the package.
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.
Response in data; the rest of the body as on every call
ssh_user_listarray of objectrequiredssh_user_list[].usernamestringrequiredThe user name to log in with (ssh<number>) - what the other SSH user tools take.
ssh_user_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
ssh_user_list[].statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
ssh_user_list[].is_usable_nowbooleanrequiredIt can log in right now: active and not expired.
ssh_user_list[].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.
ssh_user_list[].shellstring | nullrequiredThe shell: bash, zsh, or git (git only - for pushing and pulling repositories).
ssh_user_list[].quota_mbinteger | nullrequiredDisk space in MB the files it owns may take; null: no limit of its own (the package's applies).
ssh_user_list[].created_atstring | nullrequiredWhen it was created.
ssh_user_list[].last_login_atstring | nullrequiredIts last login, null if never.
count_maxinteger | nullrequiredHow many SSH users the package allows.
connectionobjectrequiredconnection.hoststring | nullrequiredThe host to connect to - the web server of the package.
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.