API

Share IP addresses

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

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 BGP based failover service within the internal system of the primary Linode.

📘

A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a legacy configuration profile VPC interface or on a Linode VPC interface.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: ips:read_write, linodes:read_write

CLI

linode-cli networking ip-share \
  --linode_id 123 \
  --ips 192.0.2.1 \
  --ips 2001:db8:3c4d:15::

Learn more

Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
Body Params

A request object IP Addresses Share (POST /networking/ips/share).

ips
array of strings
required

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.
ips*
integer
required

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

Responses

Updated 25 days ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated 25 days ago