Skip to content

Open a VPS console

GET /api/v2/vps/{id}/console

Get a link that opens the VPS’s screen and keyboard in the browser. Use it to reach a server you cannot log in to over the network, for example after a firewall or SSH mistake. The link contains a login ticket. Open it right away and do not store or share it. The VPS must be active. Otherwise the call answers 409 vps_not_active. A VPS that is still being set up also answers 409, with the code upstream_failed. Try again once setup has finished. A VPS that has used up its bandwidth answers 403 forbidden until the usage resets or the limit is raised. 409 vps_ownership_mapping_conflict means our records of which VPS this is disagree. Support has to fix that first. You can get at most 10 console links a minute. With an API key they are counted per IP address. More answer 429 rate_limit_exceeded with Retry-After.

Authentication: An API key with the scope console:vm. About keys and scopes

Request

Path parameters

idstringrequired
The VPS ID (vps_…).

Example

GET /api/v2/vps/{id}/console
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/console" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 Console link.

Response 200
{
"consoleUrl": "https://console.hostup.se/novnc/vncconsole.html?ticket=YOUR_TOKEN"
}
Response fields
consoleUrlstring
Browser link to the VPS console. It contains a login ticket.

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. With requiredScopes in the body, the API key lacks a scope. Without it, the VPS has used up its bandwidth. Console access opens again when the usage resets or the limit is raised.
404Not found. The resource does not exist or is not owned by the caller; code is vps_not_found.
409The VPS is not active (vps_not_active). A VPS that is still being set up answers 409 with the code upstream_failed: try again once setup has finished. vps_ownership_mapping_conflict means our records of which VPS this is disagree. Support has to fix that case.
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.