Skip to main content
POST
/
flowrule
cURL
curl --request POST \
  --url https://api.ck-itsolutions.nl/v1/flowrule \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "dst": false,
  "protocol": "<string>",
  "rate": {
    "mbit": 0,
    "kpps": 0
  },
  "layer4": false,
  "port": {
    "match": false,
    "src": {
      "start": 0,
      "end": 0
    },
    "dst": {
      "start": 0,
      "end": 0
    }
  },
  "packetlength": {
    "start": 0,
    "end": 0
  },
  "threshold": {
    "set": false,
    "mbit": 0,
    "kpps": 0
  },
  "layer7": false,
  "priority": 123
}
'
import requests

url = "https://api.ck-itsolutions.nl/v1/flowrule"

payload = {
"dst": False,
"protocol": "<string>",
"rate": {
"mbit": 0,
"kpps": 0
},
"layer4": False,
"port": {
"match": False,
"src": {
"start": 0,
"end": 0
},
"dst": {
"start": 0,
"end": 0
}
},
"packetlength": {
"start": 0,
"end": 0
},
"threshold": {
"set": False,
"mbit": 0,
"kpps": 0
},
"layer7": False,
"priority": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dst: false,
protocol: '<string>',
rate: {mbit: 0, kpps: 0},
layer4: false,
port: {match: false, src: {start: 0, end: 0}, dst: {start: 0, end: 0}},
packetlength: {start: 0, end: 0},
threshold: {set: false, mbit: 0, kpps: 0},
layer7: false,
priority: 123
})
};

fetch('https://api.ck-itsolutions.nl/v1/flowrule', 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.ck-itsolutions.nl/v1/flowrule",
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([
'dst' => false,
'protocol' => '<string>',
'rate' => [
'mbit' => 0,
'kpps' => 0
],
'layer4' => false,
'port' => [
'match' => false,
'src' => [
'start' => 0,
'end' => 0
],
'dst' => [
'start' => 0,
'end' => 0
]
],
'packetlength' => [
'start' => 0,
'end' => 0
],
'threshold' => [
'set' => false,
'mbit' => 0,
'kpps' => 0
],
'layer7' => false,
'priority' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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.ck-itsolutions.nl/v1/flowrule"

payload := strings.NewReader("{\n \"dst\": false,\n \"protocol\": \"<string>\",\n \"rate\": {\n \"mbit\": 0,\n \"kpps\": 0\n },\n \"layer4\": false,\n \"port\": {\n \"match\": false,\n \"src\": {\n \"start\": 0,\n \"end\": 0\n },\n \"dst\": {\n \"start\": 0,\n \"end\": 0\n }\n },\n \"packetlength\": {\n \"start\": 0,\n \"end\": 0\n },\n \"threshold\": {\n \"set\": false,\n \"mbit\": 0,\n \"kpps\": 0\n },\n \"layer7\": false,\n \"priority\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
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.ck-itsolutions.nl/v1/flowrule")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dst\": false,\n \"protocol\": \"<string>\",\n \"rate\": {\n \"mbit\": 0,\n \"kpps\": 0\n },\n \"layer4\": false,\n \"port\": {\n \"match\": false,\n \"src\": {\n \"start\": 0,\n \"end\": 0\n },\n \"dst\": {\n \"start\": 0,\n \"end\": 0\n }\n },\n \"packetlength\": {\n \"start\": 0,\n \"end\": 0\n },\n \"threshold\": {\n \"set\": false,\n \"mbit\": 0,\n \"kpps\": 0\n },\n \"layer7\": false,\n \"priority\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ck-itsolutions.nl/v1/flowrule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dst\": false,\n \"protocol\": \"<string>\",\n \"rate\": {\n \"mbit\": 0,\n \"kpps\": 0\n },\n \"layer4\": false,\n \"port\": {\n \"match\": false,\n \"src\": {\n \"start\": 0,\n \"end\": 0\n },\n \"dst\": {\n \"start\": 0,\n \"end\": 0\n }\n },\n \"packetlength\": {\n \"start\": 0,\n \"end\": 0\n },\n \"threshold\": {\n \"set\": false,\n \"mbit\": 0,\n \"kpps\": 0\n },\n \"layer7\": false,\n \"priority\": 123\n}"

response = http.request(request)
puts response.read_body
{}
{
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json

Plant to add to the store

dst
string
required

Destination IP the flowrule needs to be created for (subnets supported).

Example:

false

protocol
string
required

Protocol type (e.g., tcp, udp).

rate
object
required
layer4
boolean
required

Indicates if layer 4 filtering is applied

Example:

false

port
object
packetlength
object
threshold
object
layer7
boolean

Indicates if layer 7 filtering is applied

Example:

false

priority
integer

Rule priority with 1 being highest priority.

Response

Returns newly created flowrule with uuid as json.

The response is of type object.