/info

Verb Response
GET JSON 200
_ _

Request prototype

$ curl -s -i -u login:password 'https://your.cympa.api/info'

/snapshot

- Creates a Grafana snapshot for a given network link name (CID) or returns datapoints

Verb Response
POST JSON 200
_ _

Parameters

Parameter Description
graph Type of Graph: traffic or latency or jitter
service CID. Name of the network link
ometrics yes: returns only datapoints. no (default): creates a grafana snapshot and returns the iframe url
timefilter Period of metrics (h for hours and d for days). Examples: 24h or 12h or 6h or 1d or 7d … or 90d. Default is 24h

- Beware that when creating a snapshot, it expires in 1 hour.

Request prototype

$ curl -s -i -u login:password 'https://your.cympa.api/snapshot?service=A_TNMS_SERVICE_NAME&graph=traffic&ometrics=yes&timefilter=1h'
$ curl -X POST -s -u login:password "https://your.cympa.api/snapshot?service=A_TNMS_SERVICE_NAME&graph=latency&ometrics=no&timefilter=1h"

/alert/topcids

- Custom Latency deviation formulat. top 5% CIDs

Verb Response
GET JSON 200
_ _

Request prototype

$ curl -X GET -s -u login:password "https://your.cympa.api/alert/topcids"

/locations

- Utility endpoint that returns world cities and their Geo-coordinates.

Verb Response
GET JSON 200
_ _

Request prototype

$ curl -X GET -s -u login:password "https://your.cympa.api/locations"

/device

- Add/Updates an NE device entry in the polled devices list and synchronizes the list to all pollers.

Verb Response
POST-UPDATE-PATCH-PUT JSON 200

Parameters

Parameter Description Required
name NE name (XXX-XXX-XXX) Yes
host NE IP address Yes
enabled 0: Disabled. 1: Enabled. Yes
ctype CEM60, CEM92M, CEM100 Yes
wait Seconds to wait before getting NE info. Default is 50 No
perfwait Seconds to wait before fetching performance results. Default is 50 No
poller Poller ID (1, 2 or 3) No

/device/list

- Returns a list of Coriant devices.

Verb Response
GET JSON 200
_

Request prototype

$ curl -X GET -s -u login:password "https://your.cympa.api/device/list"
  • - Returns the last 15miutes average latency of a backbone link, along with its bandwidth and status.
  • - Verb: GET
  • - Response: 200 JSON.

Response

Attribute Description Comment
administrative_status Carrier port administrative status. 1 = UP _
bandwidth_in Input bandwidth in bytes _
bandwidth_out Output bandwidth in bytes _
entries Number of metrics rows used to compute average Yes
jitter Jitter in nano seconds _
latency Latency in nano seconds _
operational_status Carrier port operational status. 1: UP _
speed Port speed. 0 when port is a tunnel. _
status Link status. 1 = UP When operational status or administrative status is down, link is considered down

Request prototype

$ curl -X GET -s -u login:password "https://your.cympa.api/bblink/A_REGISTERED_BACKBONE_LINK"
  • - returns the plain list of Backbone links.
  • - Verb: GET
  • - Response: JSON 200.

Request prototype

curl -X GET -s -u login:password "https://your.cympa.api/bblink/list"

/bblink/all

  • - Returns a list of detailed information on each backbone link.
  • - Verb: GET
  • - Response: 200 JSON.

Parameters

Parameter Description Required Comment
sla retrieves SLA information (can take any value) No Not yet implemented
behavior retrieves AI information (can take any value) No Not yet implemented

Request prototype

$ curl -X GET -s -u login:password "https://your.cympa.api/bblink/all?sla=1&behavior=1"