Skip to content

Commit 9dbed6e

Browse files
committed
Add POST networking/ips/share
1 parent e311c9e commit 9dbed6e

File tree

1 file changed

+89
-1
lines changed

1 file changed

+89
-1
lines changed

openapi.yaml

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10307,6 +10307,94 @@ paths:
1030710307
--region us-east \
1030810308
--assignments.address 2001:db8:3c4d:15::/64 \
1030910309
--assignments.linode_id 123
10310+
/networking/ips/share:
10311+
x-linode-cli-command: networking
10312+
post:
10313+
servers:
10314+
- url: https://api.linode.com/v4beta
10315+
x-linode-grant: read_write
10316+
tags:
10317+
- Networking
10318+
summary: IP Addresses Share
10319+
description: |
10320+
Configure shared IPs.
10321+
10322+
IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if
10323+
the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be
10324+
automatically rerouted to secondary Linodes at the configured shared IP addresses.
10325+
10326+
IP failover requires configuration of a failover service (such as [Keepalived](/docs/guides/ip-failover-keepalived#configuring-ip-sharing))
10327+
within the internal system of the primary Linode.
10328+
10329+
**Note**: IPv6 range sharing has limited availability in certain regions. Please contact customer support for
10330+
assistance in enabling IPv6 range sharing for your Linodes.
10331+
10332+
**Beta**: This endpoint is in beta. Please make sure to prepend all requests with
10333+
`/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
10334+
updates in the future. This notice will be removed when this endpoint is out of
10335+
beta.
10336+
operationId: shareIPs
10337+
x-linode-cli-action: ip-share
10338+
security:
10339+
- personalAccessToken: []
10340+
- oauth:
10341+
- ips:read_write
10342+
- linodes:read_write
10343+
requestBody:
10344+
description: Information about what IPs to share with which Linode.
10345+
required: true
10346+
content:
10347+
application/json:
10348+
schema:
10349+
required:
10350+
- linode_id
10351+
- ips
10352+
properties:
10353+
linode_id:
10354+
type: integer
10355+
description: >
10356+
The ID of the primary Linode that the addresses will be shared with.
10357+
example: 123
10358+
ips:
10359+
type: array
10360+
items:
10361+
type: string
10362+
format: ip
10363+
example: 192.0.2.1
10364+
description: |
10365+
A list of secondary Linode IPs to share with the primary Linode.
10366+
* Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths)
10367+
* Can include both private and public IPv4 addresses.
10368+
* You must have access to all of these addresses and they must be in the same Region as the primary
10369+
Linode.
10370+
responses:
10371+
'200':
10372+
description: IP Address allocated successfully.
10373+
content:
10374+
application/json:
10375+
schema:
10376+
$ref: '#/components/schemas/IPAddress'
10377+
default:
10378+
$ref: '#/components/responses/ErrorResponse'
10379+
x-code-samples:
10380+
- lang: Shell
10381+
source: >
10382+
curl -H "Content-Type: application/json" \
10383+
-H "Authorization: Bearer $TOKEN" \
10384+
-X POST -d '{
10385+
"linode_id": 123,
10386+
"ips": [
10387+
"192.0.2.1",
10388+
"192.0.2.2"
10389+
]
10390+
}' \
10391+
https://api.linode.com/v4/networking/ips/share
10392+
- lang: CLI
10393+
source: >
10394+
linode-cli networking ip-share \
10395+
--linode_id 123 \
10396+
--ips 192.0.2.1 \
10397+
--ips 2001:db8:3c4d:15::
1031010398
/networking/ipv4/assign:
1031110399
x-linode-cli-command: networking
1031210400
post:
@@ -10412,7 +10500,7 @@ paths:
1041210500
Configure shared IPs. A shared IP may be brought up on a Linode other
1041310501
than the one it lists in its response. This can be used to allow one
1041410502
Linode to begin serving requests should another become unresponsive.
10415-
operationId: shareIPs
10503+
operationId: shareIPv4s
1041610504
x-linode-cli-action: ip-share
1041710505
security:
1041810506
- personalAccessToken: []

0 commit comments

Comments
 (0)