Skip to content

Commit 2839142

Browse files
Added Add Firewall Devices endpoint
POST /networking/firewalls/{firewallId}/devices
1 parent ae4cf45 commit 2839142

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
@@ -8094,6 +8094,69 @@ paths:
80948094
- lang: CLI
80958095
source: >
80968096
linode-cli firewalls delete 123
8097+
/networking/firewalls/{firewallId}/devices:
8098+
parameters:
8099+
- name: firewallId
8100+
in: path
8101+
description: >
8102+
ID of the Firewall to interact with.
8103+
required: true
8104+
schema:
8105+
type: integer
8106+
x-linode-cli-command: firewalls
8107+
post:
8108+
x-linode-grant: read_write
8109+
servers:
8110+
- url: https://api.linode.com/v4beta
8111+
tags:
8112+
- Networking
8113+
summary: Add Firewall Devices
8114+
description: >
8115+
Applies this Firewall to a new device. Currently, only devices of type `linode`
8116+
are accepted. A `firewall_device_add` event is created when the Firewall device is added
8117+
successfully.
8118+
8119+
8120+
**Beta**: This endpoint is in beta. Please make sure to prepend all requests with
8121+
`/v4beta` instead of `/v4`, and be aware that this endpoint may receiving breaking
8122+
updates in the future. This notice will be removed when this endpoint is out of
8123+
beta.
8124+
operationId: createFirewallDevices
8125+
x-linode-cli-action: create
8126+
security:
8127+
- personalAccessToken: []
8128+
- oauth:
8129+
- firewall:read_write
8130+
requestBody:
8131+
content:
8132+
application/json:
8133+
schema:
8134+
required:
8135+
- id
8136+
- type
8137+
$ref: '#/components/schemas/FirewallDevices'
8138+
responses:
8139+
'200':
8140+
description: Returns information about the created Firewall.
8141+
content:
8142+
application/json:
8143+
schema:
8144+
$ref: '#/components/schemas/FirewallDevices'
8145+
default:
8146+
$ref: '#/components/responses/ErrorResponse'
8147+
x-code-samples:
8148+
- lang: Shell
8149+
source: >
8150+
curl -H "Content-Type: application/json" \
8151+
-H "Authorization: Bearer $TOKEN" \
8152+
-X POST -d '{
8153+
"type": "linode",
8154+
"id": "123"
8155+
}' \
8156+
https://api.linode.com/v4beta/networking/firewalls/123/devices
8157+
- lang: CLI
8158+
source: >
8159+
linode-cli netowrking firewalls-create-devices
80978160
/nodebalancers:
80988161
x-linode-cli-command: nodebalancers
80998162
get:
@@ -13548,6 +13611,67 @@ components:
1354813611
type: string
1354913612
example:
1355013613
- 2001:DB8::/32
13614+
FirewallDevices:
13615+
type: object
13616+
description: >
13617+
A firewall object that controls incoming and outgoing network traffic.
13618+
properties:
13619+
type:
13620+
x-linode-filterable: true
13621+
type: string
13622+
description: >
13623+
The device type.
13624+
example: linode
13625+
x-linode-cli-display: 1
13626+
id:
13627+
x-linode-filterable: true
13628+
type: integer
13629+
description: >
13630+
The device's unique ID
13631+
example: 123
13632+
x-linode-cli-display: 2
13633+
created:
13634+
x-linode-filterable: true
13635+
type: string
13636+
format: date-time
13637+
readOnly: true
13638+
description: >
13639+
When this device was created.
13640+
example: '2018-01-01T00:01:01'
13641+
x-linode-cli-display: 3
13642+
updated:
13643+
x-linode-filterable: true
13644+
type: string
13645+
format: date-time
13646+
readOnly: true
13647+
description: >
13648+
When this device was last updated.
13649+
example: '2018-01-02T00:01:01'
13650+
x-linode-cli-display: 4
13651+
entity:
13652+
type: object
13653+
readOnly: true
13654+
description: >
13655+
The entity that this Firewall has been applied to.
13656+
properties:
13657+
id:
13658+
description: The entity's ID
13659+
type: integer
13660+
example: 123
13661+
type:
13662+
description: The entity's type.
13663+
type: string
13664+
example: linode
13665+
label:
13666+
description: The entity's label.
13667+
type: string
13668+
example: my-linode
13669+
url:
13670+
description: >
13671+
The URL you can use to access this entity.
13672+
type: string
13673+
format: url
13674+
example: /v4/linode/instances/123
1355113675
Grant:
1355213676
type: object
1355313677
description: >

0 commit comments

Comments
 (0)