Get connection details for web hosting
GET /api/v2/shared-hosting/{accountId}/account-details
Get what you need to connect to a web hosting account: the control panel username, the server hostname, a ready SSH command, FTP and SFTP settings, mail client settings and the server IP address. The response also carries the plan name, service status, price and plan limits. The server hostname works before the domain points to the account. Use it for SSH, SFTP, FTPS and mail clients during a move. access.serverHostname, access.sshCommand, access.emailClient and access.ftp are null on an account that is not on cPanel. They are also null when the server details cannot be read.
Authentication: An API key with the scope read:services. About keys and scopes
Request
Path parameters
accountIdstringrequiredacct_…).Example
curl "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/account-details" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 Connection details for the account.
{ "id": "acct_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "Webbhotell Start", "primaryDomain": "example.com", "serviceStatus": "active", "nextDueAt": "2026-05-27T00:00:00.000Z", "billing": { "amount": 99, "currencyCode": "SEK", "billingCycle": "annually" }, "access": { "username": "exampleuser", "serverHostname": "server1.example.com", "sshCommand": "ssh exampleuser@server1.example.com", "emailClient": { "incomingServer": "server1.example.com", "outgoingServer": "server1.example.com", "imap": { "hostname": "server1.example.com", "port": 993, "encryption": "ssl_tls" }, "pop3": { "hostname": "server1.example.com", "port": 995, "encryption": "ssl_tls" }, "smtp": { "hostname": "server1.example.com", "ports": [ 465, 587 ], "encryption": "ssl_tls" }, "usernameFormat": "full_email_address", "webmailUrl": "https://server1.example.com:2096" }, "ftp": { "hostname": "server1.example.com", "username": "exampleuser", "ftps": { "hostname": "server1.example.com", "port": 21, "encryption": "explicit_tls" }, "sftp": { "hostname": "server1.example.com", "port": 22, "encryption": "ssh" }, "usernameFormat": "cpanel_username" } }, "serverIp": "192.0.2.10", "resources": { "diskLimitGb": 20, "memoryGb": 2, "bandwidthLimitGb": 1024, "emailAccountLimit": 25, "databaseLimit": 10, "ftpAccountLimit": 10, "addonDomainLimit": 5, "subdomainLimit": 50 }}Response fields
idstringnamestring or nullprimaryDomainstring or nullserviceStatusstringactive, suspended, pending, cancelled, terminated, expired, fraud, transferred_out, unknown.nextDueAtstring or nullbillingobjectamountnumbercurrencyCode.currencyCodestringbillingCyclestring or nullannually.accessobjectusernamestring or nullserverHostnamestring or nullsshCommandstring or nullemailClientobject or nullftpobject or nullserverIpstring or nullresourcesobject or nullnull when no limit is left.Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | shared_hosting_not_found when the ID is not a known web hosting account ID. service_not_found when the account is not on your Hostup account. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |