This API v2 documentation is currently still on progress. For any issue, please contact support@runcloud.io

RunCloud

Create a firewall rule

POST

/v2/servers/{{serverId}}/security/firewalls

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

type

string

required

“global” or “rich” firewall rule

port

integer

required

Port number or range of port number. E.g: 8000-8999

protocol

string

required

“tcp” or “udp”

ipAddress

string

optional

IP Address or CIDR, Only if type is “rich”

firewallAction

string

optional

“accept” or “reject”, Only if type is “rich”

Example

{
  "type": "rich",
  "port": 9000,
  "protocol": "tcp",
  "ipAddress": "192.168.43.0/24",
  "firewallAction": "accept"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://manage.runcloud.io/api/v2/servers/{{serverId}}/security/firewalls' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "rich",
    "port": 9000,
    "protocol": "tcp",
    "ipAddress": "192.168.43.0/24",
    "firewallAction": "accept"
}'

Responses

🟢200Success

application/json

Body

array of:

integer

required

Firewall rule ID

type

string

required

Type of firewall rule, either Global or Rich

port

string

required

Port Number

protocol

string

required

Protocol used for the firewall rule

ipAddress

null

required

IP Address

firewallAction

null

required

Accept or reject the IP

created_at

string

required

Time which firewall rule was created at

Example

[
  {
    "id": 113,
    "type": "rich",
    "port": "9000",
    "protocol": "tcp",
    "ipAddress": "192.168.43.0/24",
    "firewallAction": "accept",
    "created_at": "2024-07-24 09:16:41"
  }
]

Modified at 2024-09-04 07:29:03

Trigger systemctl command

List firewall rules