cloudSwXtch API

Prev Next

Overview

The cloudSwXtch API is intended for use to integrate the cloudSwXtch data with third-party tools for monitoring and dashboard purposes within customer user interfaces. This section will outline the API, with examples of data results. Timestamps in the API are Epoch Unix Timestamps.

The API is available in wXcked Eye by selecting the API button.

After selection, the interface shows the API Documentation page.  Calls are separated by category, and each call can be expanded for information on the specific call.  

Calls are documented by category below:

API Categories

There are three main categories in the API, and each category has its own sub-categories:

Base URL for System API and swXtch API is http://{swXtch-ctrl-ip}:{port}

Base URL for Bridge API is http://{swXtchBridge-ctrl-ip}:{port}

Default port: 80

Content type: application/json (unless specified otherwise)

Context: /swx/