Share via


1 Introduction

Network Controller Northbound Interface specifies the Northbound API (NBI) definition of the Network Controller Protocol. The NBI is a RESTful API using JSON as the message format. The first sections of this document provide an overview of the API and common usage of it. The bulk of this document is the design of the resources that make up the NBI. The resources are in order of the top-level resources with their respective descendant resources defined in conjunction with their ancestor resource. The Network Controller Protocol is used by tenants and network administrators to control data center networking.

Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative.