2. NetBeez API Overview
● What’s an API (Application Programming Interface)?
An API offers a method to interact with an application, device, or system by pulling information, or
pushing commands, via a well-defined set of instructions or routines.
● The NetBeez API enables you to access and utilize data from your
instance via JSON endpoints.
{"id":450652,"target":"www.google.com","count":0,"interval":5,"timeout":5,"start_ts":"2017-08-22T19:33:50.036-04:00","
created_at":"2017-08-22T23:33:50.000Z","agent_id":174,"test_type_id":1,"heir_id":7591,"heir_type":"PingTest","ad_hoc":
false,"test_name":null,"nb_test_templatable_type":"NbTestTemplate","nb_test_templatable_id":99,"current_alert_mode":"s
uccess","wifi_profile_id":null,"nb_target_id":32,"nb_test_template_id":99,"schedule_type":"periodic","options":{"data_
size":54,"dont_fragment":false,"tos":null,"port":null,"ping_type":2,"flags":null},"alert_mode":"success"}
● Current version of the API is read-only.
3. How to Access the API
● Endpoints documented at the following URL:
https://<DASHBOARD_ADDRESS>/swagger/index.html
● API keys generated from the NetBeez dashboard.
● API examples within the dashboard.
● Read more on this blog post.