Skip to content

Get placement group status

GET /api/v2/placement-groups/{id}/status

Get the health of a placement group and the status of each member. It holds less than GET /api/v2/placement-groups/{id}. Poll it after you add a VPS or start a resolve, until health is ok.

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

Request

Path parameters

idstringrequired
The placement group ID (pg_…).

Example

GET /api/v2/placement-groups/{id}/status
curl "https://cloud.hostup.se/api/v2/placement-groups/pg_01hxa3b4c5d6e7f8g9h0j1k2m3/status" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 Health of the group and its members.

Response 200
{
"id": "pg_01hxa3b4c5d6e7f8g9h0j1k2m3",
"health": "reconciling",
"needsAttention": false,
"members": [
{
"vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
"placementSet": "a",
"status": "placed"
},
{
"vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m4",
"placementSet": "b",
"status": "migrating"
}
]
}
Response fields
idstring
The placement group ID (pg_…).
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. actions.canResolve on GET /api/v2/placement-groups/{id} says whether a restart can fix it.
membersarray of object
vpsIdstring
The VPS ID (vps_…).
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.

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.
404No placement group with this ID in your account. code is placement_group_not_found.
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.