Sign in
Networks

List Members of a Network

List the resources attached to a specific Network.

Use the provided URI parameters to modify the result.

get/networks/{id}/members

Request

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

Path parameters

idinteger required

ID of the Network.

Example:42

ID of the Network.

Query parameters

typestring[]

Filter members by type. May be used multiple times.

The response will only contain members matching the specified types.

subnetstring[]

Filter members by the subnet they are attached to. May be used multiple times.

The response will only contain members attached to the subnets with the specified IP ranges. Uses CIDR notation.

[
  "10.0.1.0/24"
]
statusstring[]

Filter members by status. May be used multiple times.

The response will only contain members matching the specified statuses.

sortstring[]

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

For more information, see "Sorting".

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

{
  "members": [
    {
      "id": 42,
      "ip": "10.0.1.2",
      "alias_ips": [
        "10.0.1.20"
      ],
      "subnet": "10.0.1.0/24"
    }
  ],
  "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.