ADOS API v1.0

1. Introduction

ADOS support API via Internet since 1.5.0 to provide user with ability to get information of resource they have in ADOS.

User can simply use this API with http/https infrastructure without any client limitation.

The official API endpoint is https://nest.axesdn.com:8443, user can use endpoint with following resource URL to all API.

2. Login

To use this API, user must have account in ADOS, and then create API key/secret pair under account as credential in ADOS web page. With this credential, user is able to login API system via API call.

For security reason, the API uses token-based authorization mechanism. After logining, user will get two tokens --- access token and refresh token.

Login
Description

Login API system with user API credential and get access and refresh token.

Format
Action Resource URL
POST api/v1/login
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:
Refresh
Description

Refresh access token, the request header must include Authorization: Bearer <refresh token>

Format
Action Resource URL
POST api/v1/refresh
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:

3. Router

Router is core resource of API and entity performing network functions, API provides various aspect infomation related to router.

List Routers
Description

List all routers under user, the request header must include Authorization: Bearer <access token>

Format
Action Resource URL
GET api/v1/routers
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:
Get Routers Monitor Data
Description

Get current/instant monitor data of all routers under user, the request header must include Authorization: Bearer <access token>

Format
Action Resource URL
GET api/v1/routers/monitor/instant
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:
Get Router Monitor Data with Range
Description

Get monitor data of specified router during a period, the request header must include Authorization: Bearer <access token>

Format
Action Resource URL
GET api/v1/router/<router uuid>/monitor/range
Constraint

This API only allows 1 request/second per user.

Parameters:

Note: Allowed time range specified by start and end is [15s, 90d], larger than 15 seconds and less than 90 days.

Data:
Return:
Get Router TopN Sorted Data
Description

Get sorted TopN data of specified router during a period, the request header must include Authorization: Bearer <access token>

Note: before using this API, TopN function must be enabled in this router

Format
Action Resource URL
GET api/v1/router/<router uuid>/topn/sort
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:

4. Connection

Connection represent network topology and is most important indicator of network performance in ADOS, API provides various aspect infomation related to connection.

List Connections
Description

List all connections under user, the request header must include Authorization: Bearer <access token>

Format
Action Resource URL
GET api/v1/connections
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:
Get Connections Monitor Data
Description

Get current/instant monitor data of all connections under user, the request header must include Authorization: Bearer <access token>

Format
Action Resource URL
GET api/v1/connections/monitor/instant
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:
Get Connection Monitor Data with Range
Description

Get monitor data of specified connection during a period, the request header must include Authorization: Bearer <access token>

Format
Action Resource URL
GET api/v1/connection/<connection uuid>/monitor/range
Constraint

This API only allows 1 request/second per user.

Parameters:

Note: Allowed time range specified by start and end is [15s, 90d], larger than 15 seconds and less than 90 days.

Data:
Return:

5. ADAS App

List ADAS Apps

Description

List all ADAS apps under user, the request header must include Authorization: Bearer <access token>.

Format
Action Resource URL
GET api/v1/apps/adas
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:

List App Lines Monitor

Description

Get current/instant monitor data of all lines under user of one ADAS app, the request header must include Authorization: Bearer <access token>.

Format
Action Resource URL
GET api/v1/apps/adas/<id>/monitor/instant
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return:

List App E2E Monitor

Description

Get current/instant monitor data of all lines under user of one ADAS app, the request header must include Authorization: Bearer <access token>.

Format
Action Resource URL
GET api/v1/apps/adas/<id>/monitor/regions
Constraint

This API only allows 1 request/second per user.

Parameters:
Data:
Return: