# 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_ Latest version **0.1.2** (published 2016-08-29) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install vega_os_api pnpm add vega_os_api yarn add vega_os_api bun add vega_os_api ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.2 | | Published | 2016-08-29 | | First published | 2016-08-29 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Maintainers | clilye | ## Links - npm: https://www.npmjs.com/package/vega_os_api - npm.io page: https://npm.io/package/vega_os_api ## Dependencies (1) - [superagent](https://npm.io/package/superagent.md) 1.7.1 ## Recent versions - 0.1.2 (latest) — 2016-08-29 ## 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](https://github.com/swagger-api/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](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install YOUR_USERNAME/vega_os_api --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/AppsApi.md#appsAppNameGet) | **GET** /apps/{app_name} | Get application configuration and status *VegaOsApi.AppsApi* | [**appsAppNamePatch**](docs/AppsApi.md#appsAppNamePatch) | **PATCH** /apps/{app_name} | Modify application configurations *VegaOsApi.AppsApi* | [**appsGet**](docs/AppsApi.md#appsGet) | **GET** /apps | Get all application configuration and status *VegaOsApi.CommonApi* | [**rootGet**](docs/CommonApi.md#rootGet) | **GET** / | Ping the API server *VegaOsApi.HostnameApi* | [**hostnameGet**](docs/HostnameApi.md#hostnameGet) | **GET** /hostname | Return hostname information *VegaOsApi.HostnameApi* | [**hostnamePut**](docs/HostnameApi.md#hostnamePut) | **PUT** /hostname | Modify hostname information *VegaOsApi.InterfaceApi* | [**interfaceIfManagementIpGet**](docs/InterfaceApi.md#interfaceIfManagementIpGet) | **GET** /interface/{if_management}/ip | Return IP status for management interface *VegaOsApi.InterfaceApi* | [**interfaceIfManagementRoutesGet**](docs/InterfaceApi.md#interfaceIfManagementRoutesGet) | **GET** /interface/{if_management}/routes | Return network routes for management interface *VegaOsApi.InterfaceApi* | [**interfaceIfMgtGuestMacGet**](docs/InterfaceApi.md#interfaceIfMgtGuestMacGet) | **GET** /interface/{if_mgt_guest}/mac | Return MAC address for mangement interface and guest interface *VegaOsApi.InterfaceApi* | [**interfaceIfnameGet**](docs/InterfaceApi.md#interfaceIfnameGet) | **GET** /interface/{ifname} | Return configurations for interface ifname *VegaOsApi.InterfaceApi* | [**interfaceIfnameMaclearningGet**](docs/InterfaceApi.md#interfaceIfnameMaclearningGet) | **GET** /interface/{ifname}/maclearning | Return MAC learning table for interface `ifname` *VegaOsApi.InterfaceApi* | [**interfaceIfnamePatch**](docs/InterfaceApi.md#interfaceIfnamePatch) | **PATCH** /interface/{ifname} | Modify configurations for interface `ifname` *VegaOsApi.InterfaceApi* | [**interfaceIfnameStatusGet**](docs/InterfaceApi.md#interfaceIfnameStatusGet) | **GET** /interface/{ifname}/status | Return interface status for interface `ifname` *VegaOsApi.InterfaceApi* | [**interfacesGet**](docs/InterfaceApi.md#interfacesGet) | **GET** /interfaces | Return configurations for all interfaces *VegaOsApi.InterfaceApi* | [**interfacesMaclearningGet**](docs/InterfaceApi.md#interfacesMaclearningGet) | **GET** /interfaces/maclearning | Return MAC learning table for all interfaces *VegaOsApi.InterfaceApi* | [**interfacesPatch**](docs/InterfaceApi.md#interfacesPatch) | **PATCH** /interfaces | Modify configurations for all interfaces *VegaOsApi.NtpApi* | [**ntpEnableGet**](docs/NtpApi.md#ntpEnableGet) | **GET** /ntp/enable | Return NTP enable configuration *VegaOsApi.NtpApi* | [**ntpEnablePut**](docs/NtpApi.md#ntpEnablePut) | **PUT** /ntp/enable | Set NTP enable configuration *VegaOsApi.NtpApi* | [**ntpGet**](docs/NtpApi.md#ntpGet) | **GET** /ntp | Return NTP configurations *VegaOsApi.NtpApi* | [**ntpPatch**](docs/NtpApi.md#ntpPatch) | **PATCH** /ntp | Modify NTP configurations *VegaOsApi.NtpApi* | [**ntpServersDelete**](docs/NtpApi.md#ntpServersDelete) | **DELETE** /ntp/servers | Delete NTP servers *VegaOsApi.NtpApi* | [**ntpServersGet**](docs/NtpApi.md#ntpServersGet) | **GET** /ntp/servers | Return NTP servers configuration *VegaOsApi.NtpApi* | [**ntpServersPost**](docs/NtpApi.md#ntpServersPost) | **POST** /ntp/servers | Add NTP servers *VegaOsApi.NtpApi* | [**ntpServersPut**](docs/NtpApi.md#ntpServersPut) | **PUT** /ntp/servers | Set NTP servers *VegaOsApi.SyslogApi* | [**syslogEnableGet**](docs/SyslogApi.md#syslogEnableGet) | **GET** /syslog/enable | Return syslog enable configuration *VegaOsApi.SyslogApi* | [**syslogEnablePut**](docs/SyslogApi.md#syslogEnablePut) | **PUT** /syslog/enable | Set syslog enable configuration *VegaOsApi.SyslogApi* | [**syslogGet**](docs/SyslogApi.md#syslogGet) | **GET** /syslog | Return syslog configurations *VegaOsApi.SyslogApi* | [**syslogPatch**](docs/SyslogApi.md#syslogPatch) | **PATCH** /syslog | Modify syslog configurations *VegaOsApi.SyslogApi* | [**syslogServersDelete**](docs/SyslogApi.md#syslogServersDelete) | **DELETE** /syslog/servers | Delete syslog servers *VegaOsApi.SyslogApi* | [**syslogServersGet**](docs/SyslogApi.md#syslogServersGet) | **GET** /syslog/servers | Return syslog servers configuration *VegaOsApi.SyslogApi* | [**syslogServersPost**](docs/SyslogApi.md#syslogServersPost) | **POST** /syslog/servers | Add syslog servers *VegaOsApi.SyslogApi* | [**syslogServersPut**](docs/SyslogApi.md#syslogServersPut) | **PUT** /syslog/servers | Set syslog servers *VegaOsApi.SystemApi* | [**systemConfigsDefaultGet**](docs/SystemApi.md#systemConfigsDefaultGet) | **GET** /system/configs/default | Return default configurations *VegaOsApi.SystemApi* | [**systemConfigsDefaultPatch**](docs/SystemApi.md#systemConfigsDefaultPatch) | **PATCH** /system/configs/default | Modify default configurations *VegaOsApi.SystemApi* | [**systemConfigsRunningGet**](docs/SystemApi.md#systemConfigsRunningGet) | **GET** /system/configs/running | Return running configurations *VegaOsApi.SystemApi* | [**systemConfigsRunningPatch**](docs/SystemApi.md#systemConfigsRunningPatch) | **PATCH** /system/configs/running | Modify running configurations *VegaOsApi.SystemApi* | [**systemConfigsStartupGet**](docs/SystemApi.md#systemConfigsStartupGet) | **GET** /system/configs/startup | Return startup configurations *VegaOsApi.SystemApi* | [**systemConfigsStartupPatch**](docs/SystemApi.md#systemConfigsStartupPatch) | **PATCH** /system/configs/startup | Modify startup configurations *VegaOsApi.SystemApi* | [**systemDiagnosticsGet**](docs/SystemApi.md#systemDiagnosticsGet) | **GET** /system/diagnostics | Return system diagnostics *VegaOsApi.SystemApi* | [**systemDuplicatesGet**](docs/SystemApi.md#systemDuplicatesGet) | **GET** /system/duplicates | Return system duplication progress *VegaOsApi.SystemApi* | [**systemDuplicatesPost**](docs/SystemApi.md#systemDuplicatesPost) | **POST** /system/duplicates | Duplicate the current system to the other partition *VegaOsApi.SystemApi* | [**systemGet**](docs/SystemApi.md#systemGet) | **GET** /system | Return system information *VegaOsApi.SystemApi* | [**systemHardwareSensorsGet**](docs/SystemApi.md#systemHardwareSensorsGet) | **GET** /system/hardware/sensors | Returns system hardware sensor readings *VegaOsApi.SystemApi* | [**systemJournalGet**](docs/SystemApi.md#systemJournalGet) | **GET** /system/journal | Respones *VegaOsApi.SystemApi* | [**systemTimeGet**](docs/SystemApi.md#systemTimeGet) | **GET** /system/time | Return system time *VegaOsApi.SystemApi* | [**systemUpdatesGet**](docs/SystemApi.md#systemUpdatesGet) | **GET** /system/updates | Return system update progress *VegaOsApi.SystemApi* | [**systemUpdatesPost**](docs/SystemApi.md#systemUpdatesPost) | **POST** /system/updates | Update the other partition with update file in FTP directory *VegaOsApi.SystemApi* | [**systemVersionGet**](docs/SystemApi.md#systemVersionGet) | **GET** /system/version | Return system software version ## Documentation for Models - [VegaOsApi.AppInfo](docs/AppInfo.md) - [VegaOsApi.Inband](docs/Inband.md) - [VegaOsApi.InterfaceConf](docs/InterfaceConf.md) - [VegaOsApi.IpAddr](docs/IpAddr.md) - [VegaOsApi.IpRoutes](docs/IpRoutes.md) - [VegaOsApi.Qinq](docs/Qinq.md) - [VegaOsApi.Sensors](docs/Sensors.md) ## Documentation for Authorization ### basicAuth - **Type**: HTTP basic authentication --- _Source: https://npm.io/package/vega_os_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._