Skip to content

Create a placement group

POST /api/v2/placement-groups

Create an empty placement group. Then add VPSes with POST /api/v2/placement-groups/{id}/members and put the ones that must not share hardware in different sets. Creating a group costs nothing and changes no VPS.

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

Request

Body

namestringrequired
Name of the group, 1 to 120 characters. Extra spaces are collapsed.

Example

POST /api/v2/placement-groups
curl -X POST "https://cloud.hostup.se/api/v2/placement-groups" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Production database"
}'

Responses

201 The new placement group.

Response 201
{
"id": "pg_01hxa3b4c5d6e7f8g9h0j1k2m3",
"name": "Production database",
"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:00:00.000Z"
}
Response fields
idstring
The placement group ID (pg_…).
namestring
Name of the group.
policystring
Placement policy. Always spread. One of spread.
healthstring
ok: every set is apart. reconciling: a VPS is being moved. violation: VPSes from different sets share hardware. One of ok, reconciling, violation.
needsAttentionboolean
true when automatic separation could not finish. Check actions.canResolve.
compatibilityKeystring or nulldeprecated
Deprecated. Always null.
membersarray of object
VPSes in the group, oldest first.
vpsIdstring
The VPS ID (vps_…).
namestring
Hostname or label of the VPS.
instanceUrlstring
Path of the VPS page in the client area.
placementSetstring
The set the VPS belongs to. VPSes in different sets are kept on separate hardware. One of a, b, c.
statusstring
placed: 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.
addedAtstring
When the VPS joined the group.
actionsobject
canRenameobject
Whether the group can be renamed.
allowedboolean
reasonstring or null
Why the action is not allowed. null when it is.
canDeleteobject
Whether the group can be deleted.
allowedboolean
reasonstring or null
Why the action is not allowed. null when it is.
canAddMemberobject
Whether a VPS can be added.
allowedboolean
reasonstring or null
Why the action is not allowed. null when it is.
canResolveobject
Whether POST /api/v2/placement-groups/{id}/actions/resolve can separate the group now.
allowedboolean
reasonstring or null
not_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.
createdAtstring
When the group was created.
updatedAtstring
When the group was last changed.

Errors

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

400code is invalid_request. name is missing, empty or longer than 120 characters. An unknown field in the body also returns it.
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.
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.