Get Firewall Rule

Retrieve details for a VPC firewall rule

GET /projects/{projectId}/vpc/firewall-rules/{id}

Get Firewall Rule

cURL

curl --request GET \
  --url https://api.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id}', 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.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mkinf.io/v0.1/projects/{projectId}/vpc/firewall-rules/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "c8c3d306-eff4-4d35-a09e-8efe320706c2",
  "name": "default-allow-subnet-tcp-udp-us-northcentral1-a",
  "direction": "ingress",
  "action": "allow",
  "vpc_network_id": "2d7fe075-b3d6-4201-b397-b17b754bece1",
  "state": "active",
  "sources": [
    {
      "cidr": "172.27.0.0/20",
      "resource_id": ""
    }
  ],
  "source_ports": [],
  "destinations": [
    {
      "cidr": "172.27.0.0/20",
      "resource_id": ""
    }
  ],
  "destination_ports": [],
  "protocols": [
    "tcp",
    "udp"
  ]
}

Get detailed information about a specific firewall rule, including its configuration and current state.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId · string<uuid> · required

Project id

id · string<uuid> · required

Firewall rule id

Response

200 - application/json

id · string · required

name · string · required

direction · string · required

action · string · required

vpc_network_id · string · required

state · string · required

sources · object[] · required

Show child attributes

source_ports · string[] · required

destinations · object[] · required

Show child attributes

destination_ports · string[] · required

protocols · string[] · required