Sign in
Environments

Snapshot servers into a server group

Creates a server group holding exactly the given servers and responds 201 with its detail. Groups are create-only — there is no update route, because an editable group would reintroduce the drift that pinning exists to prevent. Names are unique per project, so a clash responds 409. Servers must belong to this project and must not be plugin-managed.

post/projects/{projectId}/server-groups

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

Request body

namestring required

Unique among the project's live server groups.

descriptionstring
serverIdsstring[] required

Response

The server group was created.

idstring required
namestring required
descriptionstring nullable
serverIdsstring[] required

The snapshotted server ids. Authoritative.

serverNamesstring[] required

Display names resolved at read time; a deleted server is labelled rather than dropped.

createdAtnumber nullable

Epoch milliseconds.

updatedAtnumber nullable

Changes

Changed in 1 of the 75 revisions of this API.1