Sign in
Placement Groups

Update a PlacementGroup

Updates the Placement Group properties.

Note: if the Placement Group object changes during the request, the response will be a “conflict” error.

put/placement_groups/{id}

Request

  • Base URL: https://api.hetzner.cloud/v1
  • URL: https://api.hetzner.cloud/v1/placement_groups/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

ID of the Placement Group.

Example:42

ID of the Placement Group.

Request body

namestring

New Placement Group name.

labelsobject

User-defined labels (key/value pairs) for the Resource.

Note that the set of Labels provided in the request will overwrite the existing one.

For more information, see "Labels".

Example request

{
  "name": "my Placement Group",
  "labels": {
    "environment": "prod",
    "example.com/my": "label",
    "just-a-key": ""
  }
}

Response

Request succeeded.

Example response

{
  "placement_group": {
    "id": 42,
    "name": "my-resource",
    "labels": {
      "environment": "prod",
      "example.com/my": "label",
      "just-a-key": ""
    },
    "type": "spread",
    "created": "2016-01-30T23:55:00Z",
    "servers": [
      42
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.