Servers

List Servers

Returns all existing Server objects.

get/servers

Request

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

Query parameters

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".

sortstring[]

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

For more information, see "Sorting".

statusstring[]

Filter resources by status. May be used multiple times.

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

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

{
  "servers": [
    {
      "id": 42,
      "name": "my-resource",
      "created": "2016-01-30T23:55:00Z",
      "public_net": {
        "ipv4": {
          "id": 42,
          "ip": "1.2.3.4",
          "dns_ptr": "server01.example.com"
        },
        "ipv6": {
          "id": 42,
          "ip": "2001:db8::/64",
          "dns_ptr": [
            {
              "ip": "2001:db8::1",
              "dns_ptr": "server.example.com"
            }
          ]
        },
        "floating_ips": [
          478
        ],
        "firewalls": [
          {
            "id": 42,
            "status": "applied"
          }
        ]
      },
      "private_net": [
        {
          "network": 4711,
          "ip": "10.0.0.2",
          "alias_ips": [
            "10.0.0.3",
            "10.0.0.4"
          ],
          "mac_address": "86:00:ff:2a:7d:e1"
        }
      ],
      "server_type": {
        "id": 1,
        "name": "cpx22",
        "description": "CPX22",
        "cores": 2,
        "memory": 4,
        "disk": 80,
        "prices": [
          {
            "location": "fsn1",
            "price_hourly": {
              "net": "1.0000",
              "gross": "1.1900"
            },
            "price_monthly": {
              "net": "1.0000",
              "gross": "1.1900"
            },
            "included_traffic": 654321,
            "price_per_tb_traffic": {
              "net": "1.0000",
              "gross": "1.1900"
            }
          }
        ],
        "cpu_type": "shared",
        "category": "Shared vCPU",
        "architecture": "x86",
        "deprecation": {
          "unavailable_after": "2023-09-01T00:00:00Z",
          "announced": "2023-06-01T00:00:00Z"
        },
        "locations": [
          {
            "id": 42,
            "name": "fsn1",
            "deprecation": {
              "unavailable_after": "2023-09-01T00:00:00Z",
              "announced": "2023-06-01T00:00:00Z"
            },
            "available": true
          }
        ]
      },
      "location": {
        "id": 42,
        "name": "fsn1",
        "description": "Falkenstein DC Park 1",
        "country": "DE",
        "city": "Falkenstein",
        "latitude": 50.47612,
        "longitude": 12.370071,
        "network_zone": "eu-central"
      },
      "image": {
        "id": 42,
        "type": "snapshot",
        "status": "available",
        "name": "ubuntu-24.04",
        "description": "Ubuntu 24.04 Standard 64 bit",
        "image_size": 2.3,
        "disk_size": 10,
        "created": "2016-01-30T23:55:00Z",
        "created_from": {
          "id": 1,
          "name": "Server"
        },
        "os_flavor": "ubuntu",
        "os_version": "24.04",
        "deprecated": "2018-02-28T00:00:00Z",
        "deprecation": {
          "unavailable_after": "2023-09-01T00:00:00Z",
          "announced": "2023-06-01T00:00:00Z"
        },
        "labels": {
          "environment": "prod",
          "example.com/my": "label",
          "just-a-key": ""
        },
        "architecture": "x86"
      },
      "iso": {
        "id": 42,
        "name": "FreeBSD-11.0-RELEASE-amd64-dvd1",
        "description": "FreeBSD 11.0 x64",
        "deprecation": {
          "unavailable_after": "2023-09-01T00:00:00Z",
          "announced": "2023-06-01T00:00:00Z"
        },
        "architecture": "x86"
      },
      "backup_window": "22-02",
      "outgoing_traffic": 123456,
      "ingoing_traffic": 123456,
      "included_traffic": 654321,
      "labels": {
        "environment": "prod",
        "example.com/my": "label",
        "just-a-key": ""
      },
      "primary_disk_size": 50,
      "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
        ]
      }
    }
  ],
  "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.