Create a PlacementGroup

Creates a new Placement Group.

post/placement_groups

Request

Base URL: https://api.hetzner.cloud/v1
URL: https://api.hetzner.cloud/v1/placement_groups
Auth: HTTP bearer

Request body

namestring required

Name of the Placement Group.

labelsobject

User-defined labels (key/value pairs) for the Resource. For more information, see "Labels".

type'spread' required

Define the Placement Group Type.

Example request

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

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
    ]
  },
  "action": {
    "id": 42,
    "command": "start_resource",
    "started": "2016-01-30T23:55:00Z",
    "finished": "2016-01-30T23:55:00Z",
    "progress": 100,
    "resources": [
      {
        "id": 42,
        "type": "server"
      }
    ],
    "error": {
      "code": "action_failed",
      "message": "Action failed"
    }
  }
}

Changes

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