Chapter 20: API – Application Programming Interface

In this chapter, we will learn how the OPNsense application programming interface (API) works and how to use it externally by looking at some examples. By the end of this chapter, you will understand the OPNsense API structure and how to create custom calls using it.

In this chapter, we will cover the following topics:

  • Concepts
  • Setting up API keys
  • API calls

Technical requirements

For this chapter, you will need basic knowledge of using the curl command on the CLI and a basic understanding of how HTTP protocol methods work.

Concepts

APIs are a way that software can talk with other software and integrate and automate routines. The REpresentational State Transfer (REST), also known as the RESTful ...

Get OPNsense Beginner to Professional now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.