This article is the first stop for API developers to understand the API functions and the basics of developing code with the Celona Application Programming Interface (API).

Available APIs

Management API

  • Methods supported

    • REST APIs

  • Use cases

    • Configuration: Sites, Edge Clusters, Edge Nodes, Access Points, Devices and MicroSlicing

    • Inventory Management

    • Device Lifecycle Management: Activate & De-activate

Monitoring APIs

  • Methods supported

    • Push Notifications via REST

    • Events and Alerts via HTTP/S push notification

    • Coming soon: Streaming Telemetry

  • Performance Management

    • Access Point/Device/Edge state

    • Coming soon: Application & MicroSlicing performance metrics

    • Coming soon: Access Point/Device Traffic Throughput

  • Fault Management

    • Edge Health Statistics & Alerts

    • Coming soon: Access Point and Device Health Statistics

Stats & Telemetry API

  • Methods supported

    • REST APIs - GET

  • AP & Device Details - v1/api/stats/ueDetails, v1/api/stats/apDetails

  • Top Talkers - v1/api/stats/top/{dimension}

  • Stats Data - v1/api/stats/

    • Get raw metrics & statistics per - MicroSlice, Flow, Device

  • Edge Stats - v1/api/stats/pseStats, v1/api/stats/nodeStats

    • Get system health status (cpu, memory etc) at the cluster level or node level.

  • Event Stats - v1/api/stats/events

    • Get the alerts/events from various components generated historically

  • Swagger specification: https://app.swaggerhub.com/apis/celonanetworks/celona-stats_telemetry_api_specification/1.0

Authentication

Whether you use an API tool such as Postman or communicate with APIs via code, you will need to authenticate via a Celona API key. To obtain a Celona API key:

  1. Login to the Celona Orchestrator

  2. Click on the user icon on the top right corner

  3. Click on API Keys

  4. Click on the GENERATE KEY button


To get started with the Celona Monitoring API, see our article on the topic.

Did this answer your question?