Skip to content

Commit 3f4b5a6

Browse files
Added Add Firewall Devices endpoint
POST /networking/firewalls/{firewallId}/devices
1 parent 373ab15 commit 3f4b5a6

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed

openapi.yaml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9174,6 +9174,69 @@ paths:
91749174
- lang: CLI
91759175
source: >
91769176
linode-cli firewalls delete 123
9177+
/networking/firewalls/{firewallId}/devices:
9178+
parameters:
9179+
- name: firewallId
9180+
in: path
9181+
description: >
9182+
ID of the Firewall to interact with.
9183+
required: true
9184+
schema:
9185+
type: integer
9186+
x-linode-cli-command: firewalls
9187+
post:
9188+
x-linode-grant: read_write
9189+
servers:
9190+
- url: https://api.linode.com/v4beta
9191+
tags:
9192+
- Networking
9193+
summary: Add Firewall Devices
9194+
description: >
9195+
Applies this Firewall to a new device. Currently, only devices of type `linode`
9196+
are accepted. A `firewall_device_add` event is created when the Firewall device is added
9197+
successfully.
9198+
9199+
9200+
**Beta**: This endpoint is in beta. Please make sure to prepend all requests with
9201+
`/v4beta` instead of `/v4`, and be aware that this endpoint may receiving breaking
9202+
updates in the future. This notice will be removed when this endpoint is out of
9203+
beta.
9204+
operationId: createFirewallDevices
9205+
x-linode-cli-action: create
9206+
security:
9207+
- personalAccessToken: []
9208+
- oauth:
9209+
- firewall:read_write
9210+
requestBody:
9211+
content:
9212+
application/json:
9213+
schema:
9214+
required:
9215+
- id
9216+
- type
9217+
$ref: '#/components/schemas/FirewallDevices'
9218+
responses:
9219+
'200':
9220+
description: Returns information about the created Firewall.
9221+
content:
9222+
application/json:
9223+
schema:
9224+
$ref: '#/components/schemas/FirewallDevices'
9225+
default:
9226+
$ref: '#/components/responses/ErrorResponse'
9227+
x-code-samples:
9228+
- lang: Shell
9229+
source: >
9230+
curl -H "Content-Type: application/json" \
9231+
-H "Authorization: Bearer $TOKEN" \
9232+
-X POST -d '{
9233+
"type": "linode",
9234+
"id": "123"
9235+
}' \
9236+
https://api.linode.com/v4beta/networking/firewalls/123/devices
9237+
- lang: CLI
9238+
source: >
9239+
linode-cli netowrking firewalls-create-devices
91779240
/nodebalancers:
91789241
x-linode-cli-command: nodebalancers
91799242
get:
@@ -14774,6 +14837,67 @@ components:
1477414837
type: string
1477514838
example:
1477614839
- 2001:DB8::/32
14840+
FirewallDevices:
14841+
type: object
14842+
description: >
14843+
A firewall object that controls incoming and outgoing network traffic.
14844+
properties:
14845+
type:
14846+
x-linode-filterable: true
14847+
type: string
14848+
description: >
14849+
The device type.
14850+
example: linode
14851+
x-linode-cli-display: 1
14852+
id:
14853+
x-linode-filterable: true
14854+
type: integer
14855+
description: >
14856+
The device's unique ID
14857+
example: 123
14858+
x-linode-cli-display: 2
14859+
created:
14860+
x-linode-filterable: true
14861+
type: string
14862+
format: date-time
14863+
readOnly: true
14864+
description: >
14865+
When this device was created.
14866+
example: '2018-01-01T00:01:01'
14867+
x-linode-cli-display: 3
14868+
updated:
14869+
x-linode-filterable: true
14870+
type: string
14871+
format: date-time
14872+
readOnly: true
14873+
description: >
14874+
When this device was last updated.
14875+
example: '2018-01-02T00:01:01'
14876+
x-linode-cli-display: 4
14877+
entity:
14878+
type: object
14879+
readOnly: true
14880+
description: >
14881+
The entity that this Firewall has been applied to.
14882+
properties:
14883+
id:
14884+
description: The entity's ID
14885+
type: integer
14886+
example: 123
14887+
type:
14888+
description: The entity's type.
14889+
type: string
14890+
example: linode
14891+
label:
14892+
description: The entity's label.
14893+
type: string
14894+
example: my-linode
14895+
url:
14896+
description: >
14897+
The URL you can use to access this entity.
14898+
type: string
14899+
format: url
14900+
example: /v4/linode/instances/123
1477714901
Grant:
1477814902
type: object
1477914903
description: >

0 commit comments

Comments
 (0)