Skip to content

Commit faa7526

Browse files
Merge pull request #475 from bbiggerr/firewall-create-copy-edits
[Update] Firewall Create (POST /networking/firewalls) - descriptions
2 parents 953d7ec + 678d2f4 commit faa7526

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

openapi.yaml

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10288,15 +10288,20 @@ paths:
1028810288
description: |
1028910289
Creates a Firewall to filter network traffic. Use the `rules` property to
1029010290
create inbound and outbound access rules. Use the `devices` property to assign the
10291-
Firewall to a Linode service. Currently, Firewalls can only be assigned to Linode
10291+
Firewall to a service. Currently, Firewalls can only be assigned to Linode
1029210292
instances.
1029310293

10294-
A Firewall can be assigned to a single Linode service at a time.
10294+
A Firewall can be assigned to multiple Linode instances at a time.
10295+
10296+
A Linode instance can have one active, assigned Firewall at a time.
10297+
Additional disabled Firewalls can still be added to a Linode instance.
1029510298

1029610299
A `firewall_create` Event is generated when this endpoint returns successfully.
1029710300

10298-
Cloud Firewall is not available in every data center region. For the current list of availability, access the Regions List ([GET /regions](/docs/api/regions/#regions-list)) endpoint or see the [Cloud Firewall Product Documentation](https://www.linode.com/docs/products/networking/cloud-firewall/).notice will be removed when this endpoint is out of
10299-
beta.
10301+
Cloud Firewall is not fully available in every data center region. For the current list
10302+
of locations with full availability, access the Regions List ([GET /regions](/docs/api/regions/#regions-list))
10303+
endpoint or see the [Cloud Firewall Product Documentation](https://www.linode.com/docs/products/networking/cloud-firewall/).
10304+
Certain Regions have partial Firewall availability
1030010305
operationId: createFirewalls
1030110306
x-linode-cli-action: create
1030210307
security:
@@ -10319,23 +10324,14 @@ paths:
1031910324
properties:
1032010325
devices:
1032110326
type: object
10322-
description: >
10323-
A Firewall Device assigns a Firewall to a Linode service. Currently, Firewalls
10324-
can only be assigned to Linode instances.
10325-
10326-
* A Firewall can be assigned to a single Linode service at a time.
10327-
10328-
* Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if five other active Firewalls
10329-
are already assigned to the same service.
10330-
10331-
10332-
**Note:** When a Firewall is assigned to a Linode and you attempt
10333-
to [migrate the Linode to a data center](/docs/api/linode-instances/#dc-migrationpending-host-migration-initiate) that does not support Cloud Firewalls, the migration will fail.
10334-
Use the [List Regions](/docs/api/regions/#regions-list) endpoint to view a list of a data center's capabilities.
10327+
description: |
10328+
Devices to create for this Firewall.
10329+
When a Device is created, the Firewall is assigned to its associated service.
10330+
Currently, Devices can only be created for Linode instances.
1033510331
properties:
1033610332
linodes:
1033710333
description: >
10338-
An array of Linode IDs. A Firewall Device will be created for each ID.
10334+
An array of Linode IDs. A Firewall Device is created for each ID.
1033910335
type: array
1034010336
items:
1034110337
type: integer
@@ -17039,6 +17035,7 @@ components:
1703917035
x-linode-cli-display: 5
1704017036
status:
1704117037
type: string
17038+
readOnly: true
1704217039
description: >
1704317040
The status of this Firewall.
1704417041

@@ -20927,8 +20924,7 @@ components:
2092720924
description: |
2092820925
Information about your status in our referral program.
2092920926

20930-
This information becomes accessible after this Profile's Account has established at
20931-
least $25.00 USD of total payments.
20927+
This information becomes accessible after this Profile's Account has established at least $25.00 USD of total payments.
2093220928
readOnly: true
2093320929
properties:
2093420930
code:

0 commit comments

Comments
 (0)