← Implemented Projects

17 / Integrations

BAS interacts with network rules

A separate routine calls the OPNsense API to retrieve and create NAT rules in an agreed workflow.

OPNsenseAPINATBAS
Discuss a custom integration ↗

Conceptual illustration. See the interaction diagram for data scope and directions.

The task

BAS × OPNsense API

An accounting routine needs a programmatic interface for defined network infrastructure operations.

Interaction diagram

BAS × OPNsense API

BAS routineComponents and data directions in the described implementation.Request existing rulesRequest existing rulesRequestexisting rulesRetrieved NAT rulesRetrieved NAT rulesRetrieved NATrulesRequest rule creationRequest rule creationRequest rulecreationCreate a ruleCreate a ruleCreate a ruleBAS routineBAS routineBAS routine1OPNsense APIOPNsense APIOPNsense API2NAT rulesNAT rulesNAT rules3BAS routineComponents and data directions in the described implementation.Request existing rules1Retrieved NAT rules2Request rule creation3Create a rule4BAS routineBAS routineBAS routine1OPNsense APIOPNsense APIOPNsense API2NAT rulesNAT rulesNAT rules3
Selected connectionBAS routine → OPNsense API

Request existing rules

Architecture

Technical description

A BAS routine makes API requests to OPNsense. Reading existing NAT rules and creating a rule are separate scenarios.

Data scope

Request parameters, retrieved NAT rules and rule-creation data. NAT rules are resources inside OPNsense.

Our implementation

Custom API requests, rule retrieval and a creation procedure. Editing, deletion and complete firewall administration are outside the described scope.

Requirements for a new project

Agree permitted operations and access parameters. The website does not call a production API or display real addresses and rules.

What we developed

Custom OPNsense API routine

  1. Developed OPNsense API requests.
  2. Implemented retrieval of NAT rules.
  3. Added a rule-creation procedure.

Implementation result

Implementation result

BAS has a separate programmatic tool for the agreed network-rule workflow.

Discuss your task ↗

Related projects

NEXT STEP

Discuss your task

Describe your current system, task and intended result. We will agree the scope and prepare a proposal.

[email protected] ↗Contact us on Telegram ↗Vyvick Engineering on Telegram ↗
Company and preferred timing — optional

Enquiries and personal data