Sign in
Placement Groups

List Placement Groups

Returns all Placement Group objects.

get/placement_groups

Request

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

Query parameters

sortstring[]

Sort resources by field and direction. May be used multiple times.

For more information, see "Sorting".

namestring

Filter resources by their name.

The response will only contain the resources matching exactly the specified name.

label_selectorstring

Filter resources by labels.

The response will only contain resources matching the label selector. For more information, see "Label Selector".

typestring[]

Filter resources by type. May be used multiple times.

The response will only contain the resources with the specified type.

[
  "spread"
]
pageinteger
Example:1

Page number to return. For more information, see "Pagination".

per_pageinteger
Example:25

Maximum number of entries returned per page. For more information, see "Pagination".

Response

Request succeeded.

Example response

{
  "placement_groups": [
    {
      "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
      ]
    }
  ],
  "meta": {
    "pagination": {
      "page": 3,
      "per_page": 25,
      "previous_page": 2,
      "next_page": 4,
      "last_page": 4,
      "total_entries": 100
    }
  }
}

Changes

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