Get the pause status of web hosting
GET /api/v2/shared-hosting/{accountId}/actions/pause
Check whether a web hosting account can be paused and see a running or scheduled pause. An account can be paused once every 12 months. When that limit is used, nextEligibleAt says when the account can be paused again. actions.canPause carries the same answer as available and reason. Contacts cannot manage pauses.
Authentication: An API key with the scope read:services. About keys and scopes
Request
Path parameters
accountIdstringrequiredThe web hosting account ID (
acct_…).Example
curl "https://cloud.hostup.se/api/v2/shared-hosting/acct_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/pause" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 Whether the account can be paused and the current pause.
{ "available": true, "reason": null, "actions": { "canPause": { "allowed": true, "reason": null } }, "isPaused": false, "pauseDetails": null, "nextEligibleAt": null}{ "available": false, "reason": "Pause already scheduled", "actions": { "canPause": { "allowed": false, "reason": "Pause already scheduled" } }, "isPaused": false, "pauseDetails": { "pausedAt": "2026-12-01T00:00:00.000Z", "resumeAt": "2026-12-31T00:00:00.000Z", "daysRemaining": 59 }, "nextEligibleAt": null}Response fields
availablebooleanWhether the account can be paused now.
reasonstring or nullWhy the account cannot be paused. Null when
available is true.actionsobjectcanPauseobjectallowedbooleanreasonstring or nullcodestring or nullA machine-readable code for why the action is blocked.
isPausedbooleanTrue while a pause is running. False for a pause that has not started yet.
pauseDetailsobject or nullThe running or scheduled pause. Null when there is none.
nextEligibleAtstring or nullWhen the account can be paused again. Null unless the yearly limit is used.
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 | Not found. The resource does not exist or is not owned by the caller; code is shared_hosting_not_found. |
| 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. |