Skip to content

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

accountIdstringrequired
The web hosting account ID (acct_…).

Example

GET /api/v2/shared-hosting/{accountId}/account-details
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.

Response 200
{
"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
idstring
namestring or null
The plan name.
primaryDomainstring or null
The account’s primary domain.
serviceStatusstring
The service status. One of active, suspended, pending, cancelled, terminated, expired, fraud, transferred_out, unknown.
nextDueAtstring or null
When the next renewal is due.
billingobject
The recurring price and billing period.
amountnumber
The recurring price in currencyCode.
currencyCodestring
billingCyclestring or null
The billing period, for example annually.
accessobject
usernamestring or null
The control panel username. FTP, SFTP and SSH log in with it.
serverHostnamestring or null
The hosting server’s own hostname. Use it for SSH, SFTP, FTPS and as IMAP and SMTP host while the domain does not point to the account yet.
sshCommandstring or null
A ready SSH command. Null when the username or server hostname is not known.
emailClientobject or null
Settings for a mail client. The username is the full e-mail address.
ftpobject or null
File transfer settings. They use the server hostname so they work before the domain points to the account.
serverIpstring or null
The IP address of the hosting server.
resourcesobject or null
Plan limits. A limit that is unlimited, or that the plan does not report, is left out. null when no limit is left.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404shared_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.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.