Rename a placement group
PATCH /api/v2/placement-groups/{id}
Change the name of a placement group. Members and placement do not change. Returns the updated group.
Authentication: An API key with the scope write:vm. About keys and scopes
Request
Path parameters
idstringrequiredThe placement group ID (
pg_…).Body
namestringrequiredNew name, 1 to 120 characters. Extra spaces are collapsed.
Example
curl -X PATCH "https://cloud.hostup.se/api/v2/placement-groups/pg_01hxa3b4c5d6e7f8g9h0j1k2m3" \ -H "Authorization: Bearer $HOSTUP_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Production data tier" }'Responses
200 The renamed placement group.
{ "id": "pg_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "Production data tier", "policy": "spread", "health": "ok", "needsAttention": false, "compatibilityKey": null, "members": [], "actions": { "canRename": { "allowed": true, "reason": null }, "canDelete": { "allowed": true, "reason": null }, "canAddMember": { "allowed": true, "reason": null }, "canResolve": { "allowed": false, "reason": "not_needed" } }, "createdAt": "2026-06-28T10:00:00.000Z", "updatedAt": "2026-06-28T10:10:00.000Z"}Response fields
idstringThe placement group ID (
pg_…).namestringName of the group.
policystringPlacement policy. Always
spread. One of spread.healthstringok: every set is apart. reconciling: a VPS is being moved. violation: VPSes from different sets share hardware. One of ok, reconciling, violation.needsAttentionbooleantrue when automatic separation could not finish. Check actions.canResolve.compatibilityKeystring or nulldeprecatedDeprecated. Always
null.membersarray of objectVPSes in the group, oldest first.
vpsIdstringThe VPS ID (
vps_…).namestringHostname or label of the VPS.
instanceUrlstringPath of the VPS page in the client area.
placementSetstringThe set the VPS belongs to. VPSes in different sets are kept on separate hardware. One of
a, b, c.statusstringplaced: on hardware no other set uses. migrating: being moved. colocated: shares hardware with a VPS from another set. unknown: its location could not be read. One of placed, migrating, colocated, unknown.addedAtstringWhen the VPS joined the group.
actionsobjectcanRenameobjectWhether the group can be renamed.
allowedbooleanreasonstring or nullWhy the action is not allowed.
null when it is.canDeleteobjectWhether the group can be deleted.
allowedbooleanreasonstring or nullWhy the action is not allowed.
null when it is.canAddMemberobjectWhether a VPS can be added.
allowedbooleanreasonstring or nullWhy the action is not allowed.
null when it is.canResolveobjectWhether
POST /api/v2/placement-groups/{id}/actions/resolve can separate the group now.allowedbooleanreasonstring or nullnot_needed: nothing to fix with a restart. no_restart_target: no separate hardware is free right now. null when allowed is true. One of not_needed, no_restart_target.createdAtstringWhen the group was created.
updatedAtstringWhen the group was last changed.
Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | code is invalid_request. name is missing, empty or longer than 120 characters. An unknown field in the body also returns it. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | No placement group with this ID in your account. code is placement_group_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. |