Skip to content

Check control panel login for web hosting

GET /api/v2/shared-hosting/{accountId}/actions/sso

Check whether a control panel login link can be created for a web hosting account. A link is only available for an active account. Create the link with POST /api/v2/shared-hosting/{accountId}/actions/sso, which checks again.

Authentication: An API key with the scope read:hosting. About keys and scopes

Request

Path parameters

accountIdstringrequired
The web hosting account ID (acct_…).

Example

GET /api/v2/shared-hosting/{accountId}/actions/sso
curl "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/sso" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 Whether a login link can be created.

Response 200
{
"available": true,
"reason": null
}
Response fields
availableboolean
Whether a control panel login link can be created now.
reasonstring or null
Why not. Null when available is true.

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.
404Not found. The resource does not exist or is not owned by the caller; code is shared_hosting_not_found.
409Conflict. code is account_suspended.
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.
502Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists.