External API:

1 High Level Component Definition and Architectural Relationships 

External API exposes ONAPs capabilities through TMF standardized interfaces.  It enables ONAP to hide the internal API.

It provides

  • Exposes the ONAP service catalogue capabilities

  • Exposes the ONAP inventory capabilities

  • Exposes ONAP Service Ordering capabilities

  • Interfaces to manage subscription to ExternalAPI events 

2. API definitions

External API provides the following interfaces:

Interface NameInterface Definition Interface Capabilities
ExternalAPIE-1 NBI Management Interface

Provides a healthcheck to verify that the NBI component is running fine

  • Healthcheck of a NBI service
ExternalAPIE-2 Subscription Management Interface

Provides the ability to subscribe to and unsubscribe from External API events.

(also known as the External API Hub interface) 

  • Create/Delete a Notification
  • List notification
  • Retrieve a notification
  • Listen to notifications
ExternalAPIE-3 Service Catalogue Interface Find service specifications that can be instantiated


  • Search for services in the catalogue (with filters)
  • Retrieve a service specification from the catalogue
ExternalAPIE-4 Service Ordering Interface Request the instantiation of a service


  • Search for service orders
  • Retrieve a service order
  • Request a service instantiation
ExternalAPIE-5 Service Inventory Interface Query information about instantiated services Provides
  • Search for instantiated Services
  • Retrieve information about an instantiated order

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The current API documents can be found at:

ExternalAPI consumes the following Interfaces:

Interface NamePurpose Reason For Use
SDCE-6To receive the notifications of a new service.
SDCE-7To query the catalogue for service specifications 
SOE-X To request a service instantiation 
AAIE-1 To query the instantiated services 
MSBE-1Register NBI API

Poll 2 topics:

AAI events

SDC events

3. Component Description:

A more detailed figure and description of the component.

<< For later inclusion >>

4. Known system limitations

  • FFS

5. Used Models

ExternalAPI uses the following models:

  • -

6. System Deployment Architecture

7. New Capabilities in this Release

8. References

  1. External API architecture:
  2. External API interface: 

  • No labels