vega_os_api

This_is_a_Vega_OS_Api_Reference__Content_Type_is_applicationjson_All_timestamps_are_returned_in_ISO_8601_format__All_keyvalue_are_optional_unless_noted_otherwise_

Usage no npm install needed!

<script type="module">
  import vegaOsApi from 'https://cdn.skypack.dev/vega_os_api';
</script>

README

vega_os_api

VegaOsApi - JavaScript client for vega_os_api This is a Vega OS Api Reference. * Content-Type is application/json * All timestamps are returned in ISO 8601 format: * All key/value are optional unless noted otherwise. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1.2
  • Package version: 0.1.2
  • Build date: 2016-08-29T00:53:12.448Z
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install vega_os_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/vega_os_api then install it via:

    npm install YOUR_USERNAME/vega_os_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var VegaOsApi = require('vega_os_api');

var defaultClient = VegaOsApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new VegaOsApi.AppsApi()

var appName = "appName_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsAppNameGet(appName, callback);

Documentation for API Endpoints

All URIs are relative to http://218.108.7.113:8080/

Class Method HTTP request Description
VegaOsApi.AppsApi appsAppNameGet GET /apps/{app_name} Get application configuration and status
VegaOsApi.AppsApi appsAppNamePatch PATCH /apps/{app_name} Modify application configurations
VegaOsApi.AppsApi appsGet GET /apps Get all application configuration and status
VegaOsApi.CommonApi rootGet GET / Ping the API server
VegaOsApi.HostnameApi hostnameGet GET /hostname Return hostname information
VegaOsApi.HostnameApi hostnamePut PUT /hostname Modify hostname information
VegaOsApi.InterfaceApi interfaceIfManagementIpGet GET /interface/{if_management}/ip Return IP status for management interface
VegaOsApi.InterfaceApi interfaceIfManagementRoutesGet GET /interface/{if_management}/routes Return network routes for management interface
VegaOsApi.InterfaceApi interfaceIfMgtGuestMacGet GET /interface/{if_mgt_guest}/mac Return MAC address for mangement interface and guest interface
VegaOsApi.InterfaceApi interfaceIfnameGet GET /interface/{ifname} Return configurations for interface ifname
VegaOsApi.InterfaceApi interfaceIfnameMaclearningGet GET /interface/{ifname}/maclearning Return MAC learning table for interface `ifname`
VegaOsApi.InterfaceApi interfaceIfnamePatch PATCH /interface/{ifname} Modify configurations for interface `ifname`
VegaOsApi.InterfaceApi interfaceIfnameStatusGet GET /interface/{ifname}/status Return interface status for interface `ifname`
VegaOsApi.InterfaceApi interfacesGet GET /interfaces Return configurations for all interfaces
VegaOsApi.InterfaceApi interfacesMaclearningGet GET /interfaces/maclearning Return MAC learning table for all interfaces
VegaOsApi.InterfaceApi interfacesPatch PATCH /interfaces Modify configurations for all interfaces
VegaOsApi.NtpApi ntpEnableGet GET /ntp/enable Return NTP enable configuration
VegaOsApi.NtpApi ntpEnablePut PUT /ntp/enable Set NTP enable configuration
VegaOsApi.NtpApi ntpGet GET /ntp Return NTP configurations
VegaOsApi.NtpApi ntpPatch PATCH /ntp Modify NTP configurations
VegaOsApi.NtpApi ntpServersDelete DELETE /ntp/servers Delete NTP servers
VegaOsApi.NtpApi ntpServersGet GET /ntp/servers Return NTP servers configuration
VegaOsApi.NtpApi ntpServersPost POST /ntp/servers Add NTP servers
VegaOsApi.NtpApi ntpServersPut PUT /ntp/servers Set NTP servers
VegaOsApi.SyslogApi syslogEnableGet GET /syslog/enable Return syslog enable configuration
VegaOsApi.SyslogApi syslogEnablePut PUT /syslog/enable Set syslog enable configuration
VegaOsApi.SyslogApi syslogGet GET /syslog Return syslog configurations
VegaOsApi.SyslogApi syslogPatch PATCH /syslog Modify syslog configurations
VegaOsApi.SyslogApi syslogServersDelete DELETE /syslog/servers Delete syslog servers
VegaOsApi.SyslogApi syslogServersGet GET /syslog/servers Return syslog servers configuration
VegaOsApi.SyslogApi syslogServersPost POST /syslog/servers Add syslog servers
VegaOsApi.SyslogApi syslogServersPut PUT /syslog/servers Set syslog servers
VegaOsApi.SystemApi systemConfigsDefaultGet GET /system/configs/default Return default configurations
VegaOsApi.SystemApi systemConfigsDefaultPatch PATCH /system/configs/default Modify default configurations
VegaOsApi.SystemApi systemConfigsRunningGet GET /system/configs/running Return running configurations
VegaOsApi.SystemApi systemConfigsRunningPatch PATCH /system/configs/running Modify running configurations
VegaOsApi.SystemApi systemConfigsStartupGet GET /system/configs/startup Return startup configurations
VegaOsApi.SystemApi systemConfigsStartupPatch PATCH /system/configs/startup Modify startup configurations
VegaOsApi.SystemApi systemDiagnosticsGet GET /system/diagnostics Return system diagnostics
VegaOsApi.SystemApi systemDuplicatesGet GET /system/duplicates Return system duplication progress
VegaOsApi.SystemApi systemDuplicatesPost POST /system/duplicates Duplicate the current system to the other partition
VegaOsApi.SystemApi systemGet GET /system Return system information
VegaOsApi.SystemApi systemHardwareSensorsGet GET /system/hardware/sensors Returns system hardware sensor readings
VegaOsApi.SystemApi systemJournalGet GET /system/journal Respones
VegaOsApi.SystemApi systemTimeGet GET /system/time Return system time
VegaOsApi.SystemApi systemUpdatesGet GET /system/updates Return system update progress
VegaOsApi.SystemApi systemUpdatesPost POST /system/updates Update the other partition with update file in FTP directory
VegaOsApi.SystemApi systemVersionGet GET /system/version Return system software version

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication