Networking

IP Addresses Share

post
https://api.linode.com/v4beta/networking/ips/share
BETA

Configure shared IPs.

IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.

IP failover requires configuration of a failover service (such as Keepalived) within the internal system of the primary Linode.

Request Body Schema

ips
Required
array

A list of secondary Linode IPs to share with the primary Linode.

  • Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths)
  • Can include both private and public IPv4 addresses.
  • You must have access to all of these addresses and they must be in the same Region as the primary Linode.
  • Enter an empty array to remove all shared IP addresses.
linode_id
Required
integer

The ID of the primary Linode that the addresses will be shared with.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "linode_id": 123,
      "ips": [
        "192.0.2.1",
        "2001:db8:3c4d:15::"
      ]
    }' \
    https://api.linode.com/v4beta/networking/ips/share

Response Samples

{}

Responses

200: IP Address sharing successful.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.