Introduction

The purpose of this document is to enumerate the APIs which are exposed by Akraino Blueprint project to the external projects Akraino/Non-Akraino for interaction/integration.

This document should be used in conjunction with the architecture document to understand APIs at the modular level and their interactions.

This document should function as a glossary of APIs with its functionality, interfaces, inputs and expected outcomes.

ICN project has multiple sub-projects. All the projects expose the APIs to users. The users can these APIs to give inputs and retrieve the information.

The document follows Akriano API subcommittee API categories. Please find more information here - Blueprint Projects API Reporting Requirements

API Group

ICN EMCO API

API Group Name: ICN EMCO API

API Category Level 1: Application_Enabler

API Sub-category Level 2: General_Edge_Paas

API  Sub-category Level 3: Service_Management

API  Sub-category Level 4: n/a

Edge MultiCluster Orchestration is the service orchestration that could deploy the workload by using API. 

For more information refer - https://wiki.onap.org/display/DW/V2+API+Specification

ICN EMCO-DCM API

API Group Name: ICN EMCO-DCM API

API Category Level 1: Application_Enabler

API Sub-category Level 2: General_Edge_Paas

API  Sub-category Level 3: Service_Management

API  Sub-category Level 4: n/a

Edge MultiCluster Orchestration is the service orchestration that uses Distributed Cloud Manager(DCM) API to create Logical cloud in the edges. 

For more information refer - https://wiki.onap.org/pages/viewpage.action?pageId=76875956#DistributedCloudManager(DCM)-RESTAPI

ICN SDEWAN-CNF API

API Group Name: ICN SDEWAN CNI API

API Category Level 1: Edge_Infrastructure

API Sub-category Level 2: Network

API  Sub-category Level 3: n/a

API  Sub-category Level 4: n/a

SDEWAN CNF API enables the user to creates for Firewall using SDEWAN APIs.

For more information refer - https://lf-akraino.atlassian.net/wiki/display/AK/SDEWAN+CNF#SDEWANCNF-SDEWANInterface

ICN SDEWAN-IPsec API

API Group Name: ICN SDEWAN-IPSEC

API Category Level 1: Edge_Infrastructure

API Sub-category Level 2: Network

API  Sub-category Level 3: n/a

API  Sub-category Level 4: n/a

SDEWAN CNF API enables the user to creates IPSec tunnels between the edges using SDEWAN APIs.

For more information refer - https://lf-akraino.atlassian.net/wiki/display/AK/IPSec+Design#IPSecDesign-IPSecRestAPI

ICN SDEWAN-Controller API

API Group Name: ICN SDEWAN-Controller API

API Category Level 1: Edge_Infrastructure

API Sub-category Level 2: Network

API  Sub-category Level 3: n/a

API  Sub-category Level 4: n/a

SDEWAN Controller API enables the user to set commands to Device Manager, Hub manager and overlay manager.

For more information refer - https://lf-akraino.atlassian.net/wiki/display/AK/SDEWAN+Central+Controller#SDEWANCentralController-RestfulAPIdefinitionandBack-Endflow

ICN BPA-Rest API

API Group Name: ICN BPA-Rest API

API Category Level 1: Edge_Infrastructure

API Sub-category Level 2: Storage

API  Sub-category Level 3: n/a

API  Sub-category Level 4: n/a

ICN Binary Provisioning Agent(BPA) enable the users to send OS image, binary file and container images to the local controller in the edge.

For more information refer - https://lf-akraino.atlassian.net/wiki/pages/viewpage.action?pageId=13665411#RESTfulAPIBinaryProvisioningAgent(BPA)-Implementation