Update a Floating IP

Update a Floating IP.

put/floating_ips/{id}

Request

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

Path parameters

idinteger required

ID of the Floating IP.

Example:42

ID of the Floating IP.

Request body

descriptionstring nullable

Description of the Resource.

namestring

Name of the Resource. Must be unique per Project.

labelsobject

User-defined labels (key/value pairs) for the Resource.

Note that the set of Labels provided in the request will overwrite the existing one.

For more information, see "Labels".

Example request

{
  "description": "This describes my resource",
  "name": "my-resource",
  "labels": {
    "environment": "prod",
    "example.com/my": "label",
    "just-a-key": ""
  }
}

Response

Request succeeded.

Example response

{
  "floating_ip": {
    "id": 42,
    "name": "my-resource",
    "description": "This describes my resource",
    "ip": "2001:db8::/64",
    "type": "ipv6",
    "server": 42,
    "dns_ptr": [
      {
        "ip": "2001:db8::1",
        "dns_ptr": "server.example.com"
      }
    ],
    "home_location": {
      "id": 42,
      "name": "fsn1",
      "description": "Falkenstein DC Park 1",
      "country": "DE",
      "city": "Falkenstein",
      "latitude": 50.47612,
      "longitude": 12.370071,
      "network_zone": "eu-central"
    },
    "labels": {
      "environment": "prod",
      "example.com/my": "label",
      "just-a-key": ""
    },
    "created": "2016-01-30T23:55:00Z"
  }
}

Changes

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