F5OS-A/F5 rSeries - API

Welcome to the F5OS-A on the rSeries API page. These APIs follow the Representational State Transfer (REST) model for both public and private consumption.

The F5OS RESTCONF/NETCONF programmability interface is based on standard OpenConfig YANG data models. F5OS leverages these OpenConfig schemas and extends them with F5-specific namespaces to manage hardware, network, and software images. For certain fields (e.g., openconfig-if-ethernet:port-speed), valid values are defined externally in the OpenConfig YANG repositories, not within F5 documentation. For reference, see the official OpenConfig YANG model repositories:

openconfig/public: Repository for publishing OpenConfig models, documentation, and other material developed by the OpenConfig operators group.

API References

There is an API reference for major versions of F5OS-A (the version of F5OS for F5 r2000/r4000/r5000/r10000 systems). Each of these opens in a new window.

API Workflows

For information about common API workflows for managing the system, tenants, and more, see API Workflows.