Create Firewall Rule
curl --request POST \
--url https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "tcp",
"subnet": "0.0.0.0",
"subnet_size": "0",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"port": "443",
"desc": "Allow HTTPS traffic"
}
'import requests
url = "https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules"
payload = {
"protocol": "tcp",
"subnet": "0.0.0.0",
"subnet_size": "0",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"port": "443",
"desc": "Allow HTTPS traffic"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'tcp',
subnet: '0.0.0.0',
subnet_size: '0',
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
port: '443',
desc: 'Allow HTTPS traffic'
})
};
fetch('https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'protocol' => 'tcp',
'subnet' => '0.0.0.0',
'subnet_size' => '0',
'team_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'port' => '443',
'desc' => 'Allow HTTPS traffic'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules"
payload := strings.NewReader("{\n \"protocol\": \"tcp\",\n \"subnet\": \"0.0.0.0\",\n \"subnet_size\": \"0\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"port\": \"443\",\n \"desc\": \"Allow HTTPS traffic\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"tcp\",\n \"subnet\": \"0.0.0.0\",\n \"subnet_size\": \"0\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"port\": \"443\",\n \"desc\": \"Allow HTTPS traffic\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"protocol\": \"tcp\",\n \"subnet\": \"0.0.0.0\",\n \"subnet_size\": \"0\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"port\": \"443\",\n \"desc\": \"Allow HTTPS traffic\"\n}"
response = http.request(request)
puts response.read_body{
"firewall_rule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "allow",
"port": "443",
"subnet": "0.0.0.0",
"subnet_size": "0",
"desc": "Allow HTTPS"
}
}Firewalls
Create Firewall Rule
Add a new rule to a firewall group.
Special subnet values: Cloudflare, Onidel, HetrixTools, CloudFront, UptimeRobot.
To reference an IP list, use list:{ip_list_id} as the subnet value.
POST
/
network
/
firewalls
/
{firewall_id}
/
rules
Create Firewall Rule
curl --request POST \
--url https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "tcp",
"subnet": "0.0.0.0",
"subnet_size": "0",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"port": "443",
"desc": "Allow HTTPS traffic"
}
'import requests
url = "https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules"
payload = {
"protocol": "tcp",
"subnet": "0.0.0.0",
"subnet_size": "0",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"port": "443",
"desc": "Allow HTTPS traffic"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'tcp',
subnet: '0.0.0.0',
subnet_size: '0',
team_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
port: '443',
desc: 'Allow HTTPS traffic'
})
};
fetch('https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'protocol' => 'tcp',
'subnet' => '0.0.0.0',
'subnet_size' => '0',
'team_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'port' => '443',
'desc' => 'Allow HTTPS traffic'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules"
payload := strings.NewReader("{\n \"protocol\": \"tcp\",\n \"subnet\": \"0.0.0.0\",\n \"subnet_size\": \"0\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"port\": \"443\",\n \"desc\": \"Allow HTTPS traffic\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"tcp\",\n \"subnet\": \"0.0.0.0\",\n \"subnet_size\": \"0\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"port\": \"443\",\n \"desc\": \"Allow HTTPS traffic\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloud.onidel.com/network/firewalls/{firewall_id}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"protocol\": \"tcp\",\n \"subnet\": \"0.0.0.0\",\n \"subnet_size\": \"0\",\n \"team_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"port\": \"443\",\n \"desc\": \"Allow HTTPS traffic\"\n}"
response = http.request(request)
puts response.read_body{
"firewall_rule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "allow",
"port": "443",
"subnet": "0.0.0.0",
"subnet_size": "0",
"desc": "Allow HTTPS"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Firewall Group UUID
Body
application/json
Available options:
tcp, udp, icmp Example:
"tcp"
IP/CIDR, special value (Cloudflare, Onidel, HetrixTools, CloudFront, UptimeRobot), or IP list (list:{uuid})
Example:
"0.0.0.0"
CIDR prefix length
Example:
"0"
Port number or range (e.g. '80', '8000:9000'). Not required for ICMP.
Example:
"443"
Example:
"Allow HTTPS traffic"
Response
Firewall rule created successfully
Show child attributes
Show child attributes
⌘I