Sign in
Primary IPs

List Primary IPs

List multiple Primary IPs.

Use the provided URI parameters to modify the result.

get/primary_ips

Request

  • Base URL: https://api.hetzner.cloud/v1
  • URL: https://api.hetzner.cloud/v1/primary_ips
  • 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".

ipstring

Filter results by IP address.

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

sortstring[]

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

For more information, see "Sorting".

Response

Request succeeded.

Example response

{
  "primary_ips": [
    {
      "id": 42,
      "name": "my-resource",
      "labels": {
        "environment": "prod",
        "example.com/my": "label",
        "just-a-key": ""
      },
      "created": "2016-01-30T23:55:00Z",
      "location": {
        "id": 42,
        "name": "fsn1",
        "description": "Falkenstein DC Park 1",
        "country": "DE",
        "city": "Falkenstein",
        "latitude": 50.47612,
        "longitude": 12.370071,
        "network_zone": "eu-central"
      },
      "ip": "2001:db8::/64",
      "dns_ptr": [
        {
          "ip": "2001:db8::1",
          "dns_ptr": "server.example.com"
        }
      ],
      "type": "ipv6",
      "auto_delete": true,
      "assignee_type": "server",
      "assignee_id": 17
    }
  ],
  "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.