EXWui REST API Documentation

Default

appsActionPost

Calls a custom app action

Calls a custom app action. An user level as required by the app might be necessary.


/apps/action

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/apps/action?pid=&action_name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer pid = 56; // Integer | PID of the app instance
        String actionName = actionName_example; // String | Name of the action to be called.
        try {
            Result result = apiInstance.appsActionPost(pid, actionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsActionPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer pid = 56; // Integer | PID of the app instance
        String actionName = actionName_example; // String | Name of the action to be called.
        try {
            Result result = apiInstance.appsActionPost(pid, actionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsActionPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Integer *pid = 56; // PID of the app instance
String *actionName = actionName_example; // Name of the action to be called. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Calls a custom app action
[apiInstance appsActionPostWith:pid
    actionName:actionName
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var pid = 56; // {Integer} PID of the app instance

var opts = { 
  'actionName': actionName_example // {String} Name of the action to be called.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsActionPost(pid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class appsActionPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var pid = 56;  // Integer | PID of the app instance
            var actionName = actionName_example;  // String | Name of the action to be called. (optional) 

            try
            {
                // Calls a custom app action
                Result result = apiInstance.appsActionPost(pid, actionName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.appsActionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$pid = 56; // Integer | PID of the app instance
$actionName = actionName_example; // String | Name of the action to be called.

try {
    $result = $api_instance->appsActionPost($pid, $actionName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appsActionPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $pid = 56; # Integer | PID of the app instance
my $actionName = actionName_example; # String | Name of the action to be called.

eval { 
    my $result = $api_instance->appsActionPost(pid => $pid, actionName => $actionName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->appsActionPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
pid = 56 # Integer | PID of the app instance
actionName = actionName_example # String | Name of the action to be called. (optional)

try: 
    # Calls a custom app action
    api_response = api_instance.apps_action_post(pid, actionName=actionName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->appsActionPost: %s\n" % e)

Parameters

Query parameters
Name Description
pid*
Integer
PID of the app instance
Required
action_name
String
Name of the action to be called.

Responses

Status: 200 - Result state.

Status: default - Error state.


appsDelete

Stops a running app

Stops an app instance. User level has to be higher or equal to WRITE.


/apps

Usage and SDK Samples

curl -X DELETE -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/apps?pid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Write_Rights_Required
        HttpBasicAuth Write_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Write_Rights_Required");
        Write_Rights_Required.setUsername("YOUR USERNAME");
        Write_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer pid = 56; // Integer | PID of the app instance to be killed.
        try {
            Result result = apiInstance.appsDelete(pid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer pid = 56; // Integer | PID of the app instance to be killed.
        try {
            Result result = apiInstance.appsDelete(pid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Write_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Integer *pid = 56; // PID of the app instance to be killed.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Stops a running app
[apiInstance appsDeleteWith:pid
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var pid = 56; // {Integer} PID of the app instance to be killed.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsDelete(pid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class appsDeleteExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Write_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var pid = 56;  // Integer | PID of the app instance to be killed.

            try
            {
                // Stops a running app
                Result result = apiInstance.appsDelete(pid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.appsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Write_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$pid = 56; // Integer | PID of the app instance to be killed.

try {
    $result = $api_instance->appsDelete($pid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Write_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $pid = 56; # Integer | PID of the app instance to be killed.

eval { 
    my $result = $api_instance->appsDelete(pid => $pid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->appsDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Write_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
pid = 56 # Integer | PID of the app instance to be killed.

try: 
    # Stops a running app
    api_response = api_instance.apps_delete(pid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->appsDelete: %s\n" % e)

Parameters

Query parameters
Name Description
pid*
Integer
PID of the app instance to be killed.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


appsGet

Returns all apps

Returns a list of all available apps


/apps

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/apps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200 result = apiInstance.appsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200 result = apiInstance.appsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns all apps
[apiInstance appsGetWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class appsGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns all apps
                inline_response_200 result = apiInstance.appsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.appsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->appsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->appsGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->appsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns all apps
    api_response = api_instance.apps_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->appsGet: %s\n" % e)

Parameters

Responses

Status: 200 - Map with apps with the keys being the app names. _(APPNAME)_ is a placeholder for the unique name of the app.

Status: default - Error state.


appsPost

Starts an app

Starts an available app, creating a new instance. User level has to be higher or equal to WRITE.


/apps

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/apps?name=&user_description=&(PARAM)...="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Write_Rights_Required
        HttpBasicAuth Write_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Write_Rights_Required");
        Write_Rights_Required.setUsername("YOUR USERNAME");
        Write_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | Name of the app to start an instance of.
        String userDescription = userDescription_example; // String | Custom description for the new instance of the app.
        String (PARAM)... = (PARAM)..._example; // String | _(PARAM)_ is a placeholder for any app-specific parameter.
        try {
            Result result = apiInstance.appsPost(name, userDescription, (PARAM)...);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | Name of the app to start an instance of.
        String userDescription = userDescription_example; // String | Custom description for the new instance of the app.
        String (PARAM)... = (PARAM)..._example; // String | _(PARAM)_ is a placeholder for any app-specific parameter.
        try {
            Result result = apiInstance.appsPost(name, userDescription, (PARAM)...);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Write_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *name = name_example; // Name of the app to start an instance of. (optional)
String *userDescription = userDescription_example; // Custom description for the new instance of the app. (optional)
String *(PARAM)... = (PARAM)..._example; // _(PARAM)_ is a placeholder for any app-specific parameter. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Starts an app
[apiInstance appsPostWith:name
    userDescription:userDescription
    (PARAM)...:(PARAM)...
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var opts = { 
  'name': name_example, // {String} Name of the app to start an instance of.
  'userDescription': userDescription_example, // {String} Custom description for the new instance of the app.
  '(PARAM)...': (PARAM)..._example // {String} _(PARAM)_ is a placeholder for any app-specific parameter.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class appsPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Write_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | Name of the app to start an instance of. (optional) 
            var userDescription = userDescription_example;  // String | Custom description for the new instance of the app. (optional) 
            var (PARAM)... = (PARAM)..._example;  // String | _(PARAM)_ is a placeholder for any app-specific parameter. (optional) 

            try
            {
                // Starts an app
                Result result = apiInstance.appsPost(name, userDescription, (PARAM)...);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.appsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Write_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$name = name_example; // String | Name of the app to start an instance of.
$userDescription = userDescription_example; // String | Custom description for the new instance of the app.
$(PARAM)... = (PARAM)..._example; // String | _(PARAM)_ is a placeholder for any app-specific parameter.

try {
    $result = $api_instance->appsPost($name, $userDescription, $(PARAM)...);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Write_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $name = name_example; # String | Name of the app to start an instance of.
my $userDescription = userDescription_example; # String | Custom description for the new instance of the app.
my $(PARAM)... = (PARAM)..._example; # String | _(PARAM)_ is a placeholder for any app-specific parameter.

eval { 
    my $result = $api_instance->appsPost(name => $name, userDescription => $userDescription, (PARAM)... => $(PARAM)...);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->appsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Write_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = name_example # String | Name of the app to start an instance of. (optional)
userDescription = userDescription_example # String | Custom description for the new instance of the app. (optional)
(PARAM)... = (PARAM)..._example # String | _(PARAM)_ is a placeholder for any app-specific parameter. (optional)

try: 
    # Starts an app
    api_response = api_instance.apps_post(name=name, userDescription=userDescription, (PARAM)...=(PARAM)...)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->appsPost: %s\n" % e)

Parameters

Query parameters
Name Description
name
String
Name of the app to start an instance of.
user_description
String
Custom description for the new instance of the app.
(PARAM)...
String
_(PARAM)_ is a placeholder for any app-specific parameter.

Responses

Status: 200 - Result state.

Status: default - Error state.


appsPut

Modifies the parameters of an app instance

Modifies the parameters of an already running app. User level has to be higher or equal to WRITE.


/apps

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/apps?pid=&user_description=&(PARAM)...="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Write_Rights_Required
        HttpBasicAuth Write_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Write_Rights_Required");
        Write_Rights_Required.setUsername("YOUR USERNAME");
        Write_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Integer pid = 56; // Integer | PID of the app instance.
        String userDescription = userDescription_example; // String | Custom description for the new instance of the app.
        String (PARAM)... = (PARAM)..._example; // String | App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter.
        try {
            Result result = apiInstance.appsPut(pid, userDescription, (PARAM)...);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer pid = 56; // Integer | PID of the app instance.
        String userDescription = userDescription_example; // String | Custom description for the new instance of the app.
        String (PARAM)... = (PARAM)..._example; // String | App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter.
        try {
            Result result = apiInstance.appsPut(pid, userDescription, (PARAM)...);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Write_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Integer *pid = 56; // PID of the app instance.
String *userDescription = userDescription_example; // Custom description for the new instance of the app. (optional)
String *(PARAM)... = (PARAM)..._example; // App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Modifies the parameters of an app instance
[apiInstance appsPutWith:pid
    userDescription:userDescription
    (PARAM)...:(PARAM)...
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var pid = 56; // {Integer} PID of the app instance.

var opts = { 
  'userDescription': userDescription_example, // {String} Custom description for the new instance of the app.
  '(PARAM)...': (PARAM)..._example // {String} App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsPut(pid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class appsPutExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Write_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var pid = 56;  // Integer | PID of the app instance.
            var userDescription = userDescription_example;  // String | Custom description for the new instance of the app. (optional) 
            var (PARAM)... = (PARAM)..._example;  // String | App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter. (optional) 

            try
            {
                // Modifies the parameters of an app instance
                Result result = apiInstance.appsPut(pid, userDescription, (PARAM)...);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.appsPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Write_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$pid = 56; // Integer | PID of the app instance.
$userDescription = userDescription_example; // String | Custom description for the new instance of the app.
$(PARAM)... = (PARAM)..._example; // String | App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter.

try {
    $result = $api_instance->appsPut($pid, $userDescription, $(PARAM)...);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appsPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Write_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $pid = 56; # Integer | PID of the app instance.
my $userDescription = userDescription_example; # String | Custom description for the new instance of the app.
my $(PARAM)... = (PARAM)..._example; # String | App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter.

eval { 
    my $result = $api_instance->appsPut(pid => $pid, userDescription => $userDescription, (PARAM)... => $(PARAM)...);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->appsPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Write_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
pid = 56 # Integer | PID of the app instance.
userDescription = userDescription_example # String | Custom description for the new instance of the app. (optional)
(PARAM)... = (PARAM)..._example # String | App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter. (optional)

try: 
    # Modifies the parameters of an app instance
    api_response = api_instance.apps_put(pid, userDescription=userDescription, (PARAM)...=(PARAM)...)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->appsPut: %s\n" % e)

Parameters

Query parameters
Name Description
pid*
Integer
PID of the app instance.
Required
user_description
String
Custom description for the new instance of the app.
(PARAM)...
String
App parameter to change. _(PARAM)_ is a placeholder for any app-specific parameter.

Responses

Status: 200 - Result state.

Status: default - Error state.


appsRunningGet

Returns all app instances

Returns all running apps (app instances)


/apps/running

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/apps/running"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_1 result = apiInstance.appsRunningGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsRunningGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_1 result = apiInstance.appsRunningGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#appsRunningGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns all app instances
[apiInstance appsRunningGetWithCompletionHandler: 
              ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appsRunningGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class appsRunningGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns all app instances
                inline_response_200_1 result = apiInstance.appsRunningGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.appsRunningGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->appsRunningGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appsRunningGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->appsRunningGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->appsRunningGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns all app instances
    api_response = api_instance.apps_running_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->appsRunningGet: %s\n" % e)

Parameters

Responses

Status: 200 - Map with app instances with the keys being the PIDs. _(PID)_ is a placeholder for the unique ID of an app instance.

Status: default - Error state.


deviceControllerDelete

Deletes the given controller.

Deletes the given controller. User level has to be higher or equal to SUPER.


/device/controller

Usage and SDK Samples

curl -X DELETE -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/controller?connection=&ip=&port="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String connection = connection_example; // String | Connection type of the controller. Either "tcp" or "ssl"
        String ip = ip_example; // String | IP address of the controller.
        String port = port_example; // String | TCP port of the controller.
        try {
            Result result = apiInstance.deviceControllerDelete(connection, ip, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceControllerDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String connection = connection_example; // String | Connection type of the controller. Either "tcp" or "ssl"
        String ip = ip_example; // String | IP address of the controller.
        String port = port_example; // String | TCP port of the controller.
        try {
            Result result = apiInstance.deviceControllerDelete(connection, ip, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceControllerDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *connection = connection_example; // Connection type of the controller. Either "tcp" or "ssl" (optional)
String *ip = ip_example; // IP address of the controller. (optional)
String *port = port_example; // TCP port of the controller. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Deletes the given controller.
[apiInstance deviceControllerDeleteWith:connection
    ip:ip
    port:port
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var opts = { 
  'connection': connection_example, // {String} Connection type of the controller. Either "tcp" or "ssl"
  'ip': ip_example, // {String} IP address of the controller.
  'port': port_example // {String} TCP port of the controller.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceControllerDelete(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceControllerDeleteExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var connection = connection_example;  // String | Connection type of the controller. Either "tcp" or "ssl" (optional) 
            var ip = ip_example;  // String | IP address of the controller. (optional) 
            var port = port_example;  // String | TCP port of the controller. (optional) 

            try
            {
                // Deletes the given controller.
                Result result = apiInstance.deviceControllerDelete(connection, ip, port);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceControllerDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$connection = connection_example; // String | Connection type of the controller. Either "tcp" or "ssl"
$ip = ip_example; // String | IP address of the controller.
$port = port_example; // String | TCP port of the controller.

try {
    $result = $api_instance->deviceControllerDelete($connection, $ip, $port);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceControllerDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $connection = connection_example; # String | Connection type of the controller. Either "tcp" or "ssl"
my $ip = ip_example; # String | IP address of the controller.
my $port = port_example; # String | TCP port of the controller.

eval { 
    my $result = $api_instance->deviceControllerDelete(connection => $connection, ip => $ip, port => $port);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceControllerDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
connection = connection_example # String | Connection type of the controller. Either "tcp" or "ssl" (optional)
ip = ip_example # String | IP address of the controller. (optional)
port = port_example # String | TCP port of the controller. (optional)

try: 
    # Deletes the given controller.
    api_response = api_instance.device_controller_delete(connection=connection, ip=ip, port=port)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceControllerDelete: %s\n" % e)

Parameters

Query parameters
Name Description
connection
String
Connection type of the controller. Either "tcp" or "ssl"
ip
String
IP address of the controller.
port
String
TCP port of the controller.

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceControllerGet

Returns the configured controller

Returns the configured controller details


/device/controller

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/controller"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_2 result = apiInstance.deviceControllerGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceControllerGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_2 result = apiInstance.deviceControllerGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceControllerGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the configured controller
[apiInstance deviceControllerGetWithCompletionHandler: 
              ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceControllerGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceControllerGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the configured controller
                inline_response_200_2 result = apiInstance.deviceControllerGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceControllerGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceControllerGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceControllerGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceControllerGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceControllerGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the configured controller
    api_response = api_instance.device_controller_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceControllerGet: %s\n" % e)

Parameters

Responses

Status: 200 - Configured controller details

Status: default - Error state.


deviceControllerPost

Adds the given controller.

Adds the given controller. User level has to be higher or equal to SUPER.


/device/controller

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/controller?connection=&ip=&port="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String connection = connection_example; // String | Connection type of the controller. Either "tcp" or "ssl"
        String ip = ip_example; // String | IP address of the controller.
        String port = port_example; // String | TCP port of the controller.
        try {
            Result result = apiInstance.deviceControllerPost(connection, ip, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceControllerPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String connection = connection_example; // String | Connection type of the controller. Either "tcp" or "ssl"
        String ip = ip_example; // String | IP address of the controller.
        String port = port_example; // String | TCP port of the controller.
        try {
            Result result = apiInstance.deviceControllerPost(connection, ip, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceControllerPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *connection = connection_example; // Connection type of the controller. Either "tcp" or "ssl" (optional)
String *ip = ip_example; // IP address of the controller. (optional)
String *port = port_example; // TCP port of the controller. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Adds the given controller.
[apiInstance deviceControllerPostWith:connection
    ip:ip
    port:port
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var opts = { 
  'connection': connection_example, // {String} Connection type of the controller. Either "tcp" or "ssl"
  'ip': ip_example, // {String} IP address of the controller.
  'port': port_example // {String} TCP port of the controller.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceControllerPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceControllerPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var connection = connection_example;  // String | Connection type of the controller. Either "tcp" or "ssl" (optional) 
            var ip = ip_example;  // String | IP address of the controller. (optional) 
            var port = port_example;  // String | TCP port of the controller. (optional) 

            try
            {
                // Adds the given controller.
                Result result = apiInstance.deviceControllerPost(connection, ip, port);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceControllerPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$connection = connection_example; // String | Connection type of the controller. Either "tcp" or "ssl"
$ip = ip_example; // String | IP address of the controller.
$port = port_example; // String | TCP port of the controller.

try {
    $result = $api_instance->deviceControllerPost($connection, $ip, $port);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceControllerPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $connection = connection_example; # String | Connection type of the controller. Either "tcp" or "ssl"
my $ip = ip_example; # String | IP address of the controller.
my $port = port_example; # String | TCP port of the controller.

eval { 
    my $result = $api_instance->deviceControllerPost(connection => $connection, ip => $ip, port => $port);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceControllerPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
connection = connection_example # String | Connection type of the controller. Either "tcp" or "ssl" (optional)
ip = ip_example # String | IP address of the controller. (optional)
port = port_example # String | TCP port of the controller. (optional)

try: 
    # Adds the given controller.
    api_response = api_instance.device_controller_post(connection=connection, ip=ip, port=port)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceControllerPost: %s\n" % e)

Parameters

Query parameters
Name Description
connection
String
Connection type of the controller. Either "tcp" or "ssl"
ip
String
IP address of the controller.
port
String
TCP port of the controller.

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceCustomidentGet

Returns the device label and notes

Returns the web UI device label and notes.


/device/customident

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/customident"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_3 result = apiInstance.deviceCustomidentGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceCustomidentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_3 result = apiInstance.deviceCustomidentGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceCustomidentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the device label and notes
[apiInstance deviceCustomidentGetWithCompletionHandler: 
              ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceCustomidentGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceCustomidentGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the device label and notes
                inline_response_200_3 result = apiInstance.deviceCustomidentGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceCustomidentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceCustomidentGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceCustomidentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceCustomidentGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceCustomidentGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the device label and notes
    api_response = api_instance.device_customident_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceCustomidentGet: %s\n" % e)

Parameters

Responses

Status: 200 - Device label and notes.

Status: default - Error state.


deviceCustomidentPost

Sets the device label and device notes

Sets the device label and device notes used in the web UI. User level has to be higher or equal to SUPER.


/device/customident

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/customident?name=¬es="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | New device label.
        String notes = notes_example; // String | New device notes.
        try {
            Result result = apiInstance.deviceCustomidentPost(name, notes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceCustomidentPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | New device label.
        String notes = notes_example; // String | New device notes.
        try {
            Result result = apiInstance.deviceCustomidentPost(name, notes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceCustomidentPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *name = name_example; // New device label.
String *notes = notes_example; // New device notes.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the device label and device notes
[apiInstance deviceCustomidentPostWith:name
    notes:notes
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var name = name_example; // {String} New device label.

var notes = notes_example; // {String} New device notes.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceCustomidentPost(name, notes, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceCustomidentPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | New device label.
            var notes = notes_example;  // String | New device notes.

            try
            {
                // Sets the device label and device notes
                Result result = apiInstance.deviceCustomidentPost(name, notes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceCustomidentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$name = name_example; // String | New device label.
$notes = notes_example; // String | New device notes.

try {
    $result = $api_instance->deviceCustomidentPost($name, $notes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceCustomidentPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $name = name_example; # String | New device label.
my $notes = notes_example; # String | New device notes.

eval { 
    my $result = $api_instance->deviceCustomidentPost(name => $name, notes => $notes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceCustomidentPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = name_example # String | New device label.
notes = notes_example # String | New device notes.

try: 
    # Sets the device label and device notes
    api_response = api_instance.device_customident_post(name, notes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceCustomidentPost: %s\n" % e)

Parameters

Query parameters
Name Description
name*
String
New device label.
Required
notes*
String
New device notes.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceDpidGet

Returns the device Openflow Datapath ID

Returns the device Datapath ID.


/device/dpid

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/dpid"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_4 result = apiInstance.deviceDpidGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceDpidGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_4 result = apiInstance.deviceDpidGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceDpidGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the device Openflow Datapath ID
[apiInstance deviceDpidGetWithCompletionHandler: 
              ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceDpidGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceDpidGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the device Openflow Datapath ID
                inline_response_200_4 result = apiInstance.deviceDpidGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceDpidGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceDpidGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceDpidGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceDpidGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceDpidGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the device Openflow Datapath ID
    api_response = api_instance.device_dpid_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceDpidGet: %s\n" % e)

Parameters

Responses

Status: 200 - Datapath ID.

Status: default - Error state.


deviceEnvironmentGet

Returns environment information

Returns various information about physical characteristics, namely status of the fans, PSU and temperature sensors.


/device/environment

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/environment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_5 result = apiInstance.deviceEnvironmentGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceEnvironmentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_5 result = apiInstance.deviceEnvironmentGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceEnvironmentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns environment information
[apiInstance deviceEnvironmentGetWithCompletionHandler: 
              ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceEnvironmentGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceEnvironmentGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns environment information
                inline_response_200_5 result = apiInstance.deviceEnvironmentGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceEnvironmentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceEnvironmentGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceEnvironmentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceEnvironmentGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceEnvironmentGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns environment information
    api_response = api_instance.device_environment_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceEnvironmentGet: %s\n" % e)

Parameters

Responses

Status: 200 - Load information.

Status: default - Error state.


deviceGenerationGet

Returns the generation

Returns the device model generation.


/device/generation

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/generation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_6 result = apiInstance.deviceGenerationGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceGenerationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_6 result = apiInstance.deviceGenerationGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceGenerationGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the generation
[apiInstance deviceGenerationGetWithCompletionHandler: 
              ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceGenerationGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceGenerationGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the generation
                inline_response_200_6 result = apiInstance.deviceGenerationGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceGenerationGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceGenerationGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceGenerationGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceGenerationGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceGenerationGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the generation
    api_response = api_instance.device_generation_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceGenerationGet: %s\n" % e)

Parameters

Responses

Status: 200 - Device model generation information.

Status: default - Error state.


deviceGrouphashGet

Returns a map of all supported group select hash keys and their states

Returns a map of all supported group select hash keys and their states. The key is an hash key available on this device. The boolean value indicates whether that hash key is used (_true_ = it is used).


/device/grouphash

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/grouphash"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_7 result = apiInstance.deviceGrouphashGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceGrouphashGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_7 result = apiInstance.deviceGrouphashGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceGrouphashGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns a map of all supported group select hash keys and their states
[apiInstance deviceGrouphashGetWithCompletionHandler: 
              ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceGrouphashGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceGrouphashGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns a map of all supported group select hash keys and their states
                inline_response_200_7 result = apiInstance.deviceGrouphashGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceGrouphashGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceGrouphashGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceGrouphashGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceGrouphashGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceGrouphashGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns a map of all supported group select hash keys and their states
    api_response = api_instance.device_grouphash_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceGrouphashGet: %s\n" % e)

Parameters

Responses

Status: 200 - map of all group select hash keys.

Status: default - Error state.


deviceGrouphashPost

Sets whether certain group select hash keys should be used or not

Sets whether certain group select hash keys should be used or not. User level has to be higher or equal to WRITE.


/device/grouphash

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/grouphash?macsa=&macda=ðer_type=&ipsa=&ipda=&ip_protocol=&src_port=&dst_port="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Write_Rights_Required
        HttpBasicAuth Write_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Write_Rights_Required");
        Write_Rights_Required.setUsername("YOUR USERNAME");
        Write_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Boolean macsa = true; // Boolean | Boolean value indicating whether MAC source address should be used as a key.
        Boolean macda = true; // Boolean | Boolean value indicating whether MAC destination address should be used as a key.
        Boolean etherType = true; // Boolean | Boolean value indicating whether the ethertype value should be used as a key.
        Boolean ipsa = true; // Boolean | Boolean value indicating whether the IP source address should be used as a key.
        Boolean ipda = true; // Boolean | Boolean value indicating whether the IP destination address should be used as a key.
        Boolean ipProtocol = true; // Boolean | Boolean value indicating whether the IP protocol number should be used as a key.
        Boolean srcPort = true; // Boolean | Boolean value indicating whether the source port should be used as a key.
        Boolean dstPort = true; // Boolean | Boolean value indicating whether the destination port should be used as a key.
        try {
            Result result = apiInstance.deviceGrouphashPost(macsa, macda, etherType, ipsa, ipda, ipProtocol, srcPort, dstPort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceGrouphashPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Boolean macsa = true; // Boolean | Boolean value indicating whether MAC source address should be used as a key.
        Boolean macda = true; // Boolean | Boolean value indicating whether MAC destination address should be used as a key.
        Boolean etherType = true; // Boolean | Boolean value indicating whether the ethertype value should be used as a key.
        Boolean ipsa = true; // Boolean | Boolean value indicating whether the IP source address should be used as a key.
        Boolean ipda = true; // Boolean | Boolean value indicating whether the IP destination address should be used as a key.
        Boolean ipProtocol = true; // Boolean | Boolean value indicating whether the IP protocol number should be used as a key.
        Boolean srcPort = true; // Boolean | Boolean value indicating whether the source port should be used as a key.
        Boolean dstPort = true; // Boolean | Boolean value indicating whether the destination port should be used as a key.
        try {
            Result result = apiInstance.deviceGrouphashPost(macsa, macda, etherType, ipsa, ipda, ipProtocol, srcPort, dstPort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceGrouphashPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Write_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Boolean *macsa = true; // Boolean value indicating whether MAC source address should be used as a key. (optional)
Boolean *macda = true; // Boolean value indicating whether MAC destination address should be used as a key. (optional)
Boolean *etherType = true; // Boolean value indicating whether the ethertype value should be used as a key. (optional)
Boolean *ipsa = true; // Boolean value indicating whether the IP source address should be used as a key. (optional)
Boolean *ipda = true; // Boolean value indicating whether the IP destination address should be used as a key. (optional)
Boolean *ipProtocol = true; // Boolean value indicating whether the IP protocol number should be used as a key. (optional)
Boolean *srcPort = true; // Boolean value indicating whether the source port should be used as a key. (optional)
Boolean *dstPort = true; // Boolean value indicating whether the destination port should be used as a key. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets whether certain group select hash keys should be used or not
[apiInstance deviceGrouphashPostWith:macsa
    macda:macda
    etherType:etherType
    ipsa:ipsa
    ipda:ipda
    ipProtocol:ipProtocol
    srcPort:srcPort
    dstPort:dstPort
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var opts = { 
  'macsa': true, // {Boolean} Boolean value indicating whether MAC source address should be used as a key.
  'macda': true, // {Boolean} Boolean value indicating whether MAC destination address should be used as a key.
  'etherType': true, // {Boolean} Boolean value indicating whether the ethertype value should be used as a key.
  'ipsa': true, // {Boolean} Boolean value indicating whether the IP source address should be used as a key.
  'ipda': true, // {Boolean} Boolean value indicating whether the IP destination address should be used as a key.
  'ipProtocol': true, // {Boolean} Boolean value indicating whether the IP protocol number should be used as a key.
  'srcPort': true, // {Boolean} Boolean value indicating whether the source port should be used as a key.
  'dstPort': true // {Boolean} Boolean value indicating whether the destination port should be used as a key.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceGrouphashPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceGrouphashPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Write_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var macsa = true;  // Boolean | Boolean value indicating whether MAC source address should be used as a key. (optional) 
            var macda = true;  // Boolean | Boolean value indicating whether MAC destination address should be used as a key. (optional) 
            var etherType = true;  // Boolean | Boolean value indicating whether the ethertype value should be used as a key. (optional) 
            var ipsa = true;  // Boolean | Boolean value indicating whether the IP source address should be used as a key. (optional) 
            var ipda = true;  // Boolean | Boolean value indicating whether the IP destination address should be used as a key. (optional) 
            var ipProtocol = true;  // Boolean | Boolean value indicating whether the IP protocol number should be used as a key. (optional) 
            var srcPort = true;  // Boolean | Boolean value indicating whether the source port should be used as a key. (optional) 
            var dstPort = true;  // Boolean | Boolean value indicating whether the destination port should be used as a key. (optional) 

            try
            {
                // Sets whether certain group select hash keys should be used or not
                Result result = apiInstance.deviceGrouphashPost(macsa, macda, etherType, ipsa, ipda, ipProtocol, srcPort, dstPort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceGrouphashPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Write_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$macsa = true; // Boolean | Boolean value indicating whether MAC source address should be used as a key.
$macda = true; // Boolean | Boolean value indicating whether MAC destination address should be used as a key.
$etherType = true; // Boolean | Boolean value indicating whether the ethertype value should be used as a key.
$ipsa = true; // Boolean | Boolean value indicating whether the IP source address should be used as a key.
$ipda = true; // Boolean | Boolean value indicating whether the IP destination address should be used as a key.
$ipProtocol = true; // Boolean | Boolean value indicating whether the IP protocol number should be used as a key.
$srcPort = true; // Boolean | Boolean value indicating whether the source port should be used as a key.
$dstPort = true; // Boolean | Boolean value indicating whether the destination port should be used as a key.

try {
    $result = $api_instance->deviceGrouphashPost($macsa, $macda, $etherType, $ipsa, $ipda, $ipProtocol, $srcPort, $dstPort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceGrouphashPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Write_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $macsa = true; # Boolean | Boolean value indicating whether MAC source address should be used as a key.
my $macda = true; # Boolean | Boolean value indicating whether MAC destination address should be used as a key.
my $etherType = true; # Boolean | Boolean value indicating whether the ethertype value should be used as a key.
my $ipsa = true; # Boolean | Boolean value indicating whether the IP source address should be used as a key.
my $ipda = true; # Boolean | Boolean value indicating whether the IP destination address should be used as a key.
my $ipProtocol = true; # Boolean | Boolean value indicating whether the IP protocol number should be used as a key.
my $srcPort = true; # Boolean | Boolean value indicating whether the source port should be used as a key.
my $dstPort = true; # Boolean | Boolean value indicating whether the destination port should be used as a key.

eval { 
    my $result = $api_instance->deviceGrouphashPost(macsa => $macsa, macda => $macda, etherType => $etherType, ipsa => $ipsa, ipda => $ipda, ipProtocol => $ipProtocol, srcPort => $srcPort, dstPort => $dstPort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceGrouphashPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Write_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
macsa = true # Boolean | Boolean value indicating whether MAC source address should be used as a key. (optional)
macda = true # Boolean | Boolean value indicating whether MAC destination address should be used as a key. (optional)
etherType = true # Boolean | Boolean value indicating whether the ethertype value should be used as a key. (optional)
ipsa = true # Boolean | Boolean value indicating whether the IP source address should be used as a key. (optional)
ipda = true # Boolean | Boolean value indicating whether the IP destination address should be used as a key. (optional)
ipProtocol = true # Boolean | Boolean value indicating whether the IP protocol number should be used as a key. (optional)
srcPort = true # Boolean | Boolean value indicating whether the source port should be used as a key. (optional)
dstPort = true # Boolean | Boolean value indicating whether the destination port should be used as a key. (optional)

try: 
    # Sets whether certain group select hash keys should be used or not
    api_response = api_instance.device_grouphash_post(macsa=macsa, macda=macda, etherType=etherType, ipsa=ipsa, ipda=ipda, ipProtocol=ipProtocol, srcPort=srcPort, dstPort=dstPort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceGrouphashPost: %s\n" % e)

Parameters

Query parameters
Name Description
macsa
Boolean
Boolean value indicating whether MAC source address should be used as a key.
macda
Boolean
Boolean value indicating whether MAC destination address should be used as a key.
ether_type
Boolean
Boolean value indicating whether the ethertype value should be used as a key.
ipsa
Boolean
Boolean value indicating whether the IP source address should be used as a key.
ipda
Boolean
Boolean value indicating whether the IP destination address should be used as a key.
ip_protocol
Boolean
Boolean value indicating whether the IP protocol number should be used as a key.
src_port
Boolean
Boolean value indicating whether the source port should be used as a key.
dst_port
Boolean
Boolean value indicating whether the destination port should be used as a key.

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceHttpsPost

Sets the HTTPS setting

Sets the HTTPS setting.


/device/https

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/https?https_enabled=&ssl_password="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Boolean httpsEnabled = true; // Boolean | Whether to enable HTTPS
        String sslPassword = sslPassword_example; // String | Password for certificate/key in plain text.
        try {
            Result result = apiInstance.deviceHttpsPost(httpsEnabled, sslPassword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceHttpsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Boolean httpsEnabled = true; // Boolean | Whether to enable HTTPS
        String sslPassword = sslPassword_example; // String | Password for certificate/key in plain text.
        try {
            Result result = apiInstance.deviceHttpsPost(httpsEnabled, sslPassword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceHttpsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Boolean *httpsEnabled = true; // Whether to enable HTTPS
String *sslPassword = sslPassword_example; // Password for certificate/key in plain text.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the HTTPS setting
[apiInstance deviceHttpsPostWith:httpsEnabled
    sslPassword:sslPassword
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var httpsEnabled = true; // {Boolean} Whether to enable HTTPS

var sslPassword = sslPassword_example; // {String} Password for certificate/key in plain text.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceHttpsPost(httpsEnabled, sslPassword, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceHttpsPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var httpsEnabled = true;  // Boolean | Whether to enable HTTPS
            var sslPassword = sslPassword_example;  // String | Password for certificate/key in plain text.

            try
            {
                // Sets the HTTPS setting
                Result result = apiInstance.deviceHttpsPost(httpsEnabled, sslPassword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceHttpsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$httpsEnabled = true; // Boolean | Whether to enable HTTPS
$sslPassword = sslPassword_example; // String | Password for certificate/key in plain text.

try {
    $result = $api_instance->deviceHttpsPost($httpsEnabled, $sslPassword);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceHttpsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $httpsEnabled = true; # Boolean | Whether to enable HTTPS
my $sslPassword = sslPassword_example; # String | Password for certificate/key in plain text.

eval { 
    my $result = $api_instance->deviceHttpsPost(httpsEnabled => $httpsEnabled, sslPassword => $sslPassword);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceHttpsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
httpsEnabled = true # Boolean | Whether to enable HTTPS
sslPassword = sslPassword_example # String | Password for certificate/key in plain text.

try: 
    # Sets the HTTPS setting
    api_response = api_instance.device_https_post(httpsEnabled, sslPassword)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceHttpsPost: %s\n" % e)

Parameters

Query parameters
Name Description
https_enabled*
Boolean
Whether to enable HTTPS
Required
ssl_password*
String
Password for certificate/key in plain text.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceIdledGet

Gets the device ID LED status

Shows whether the device ID LED is activated or not


/device/idled

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/idled"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_8 result = apiInstance.deviceIdledGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIdledGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_8 result = apiInstance.deviceIdledGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIdledGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Gets the device ID LED status
[apiInstance deviceIdledGetWithCompletionHandler: 
              ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceIdledGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceIdledGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Gets the device ID LED status
                inline_response_200_8 result = apiInstance.deviceIdledGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceIdledGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceIdledGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceIdledGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceIdledGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceIdledGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Gets the device ID LED status
    api_response = api_instance.device_idled_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceIdledGet: %s\n" % e)

Parameters

Responses

Status: 200 - Result state.


deviceIdledPost

Sets the device ID LED

Activates or deactivates the device ID LED User level has to be higher or equal to WRITE.


/device/idled

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/idled?activated="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Write_Rights_Required
        HttpBasicAuth Write_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Write_Rights_Required");
        Write_Rights_Required.setUsername("YOUR USERNAME");
        Write_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Boolean activated = true; // Boolean | true enables the LED, false disables it.
        try {
            Result result = apiInstance.deviceIdledPost(activated);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIdledPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Boolean activated = true; // Boolean | true enables the LED, false disables it.
        try {
            Result result = apiInstance.deviceIdledPost(activated);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIdledPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Write_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Boolean *activated = true; // true enables the LED, false disables it.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the device ID LED
[apiInstance deviceIdledPostWith:activated
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var activated = true; // {Boolean} true enables the LED, false disables it.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceIdledPost(activated, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceIdledPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Write_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var activated = true;  // Boolean | true enables the LED, false disables it.

            try
            {
                // Sets the device ID LED
                Result result = apiInstance.deviceIdledPost(activated);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceIdledPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Write_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$activated = true; // Boolean | true enables the LED, false disables it.

try {
    $result = $api_instance->deviceIdledPost($activated);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceIdledPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Write_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $activated = true; # Boolean | true enables the LED, false disables it.

eval { 
    my $result = $api_instance->deviceIdledPost(activated => $activated);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceIdledPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Write_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
activated = true # Boolean | true enables the LED, false disables it.

try: 
    # Sets the device ID LED
    api_response = api_instance.device_idled_post(activated)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceIdledPost: %s\n" % e)

Parameters

Query parameters
Name Description
activated*
Boolean
true enables the LED, false disables it.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceImageversionGet

Returns the version of the active image

Returns the version of the active image.


/device/imageversion

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/imageversion"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_9 result = apiInstance.deviceImageversionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceImageversionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_9 result = apiInstance.deviceImageversionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceImageversionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the version of the active image
[apiInstance deviceImageversionGetWithCompletionHandler: 
              ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceImageversionGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceImageversionGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the version of the active image
                inline_response_200_9 result = apiInstance.deviceImageversionGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceImageversionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceImageversionGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceImageversionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceImageversionGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceImageversionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the version of the active image
    api_response = api_instance.device_imageversion_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceImageversionGet: %s\n" % e)

Parameters

Responses

Status: 200 - Image version information.

Status: default - Error state.


deviceIpconfigGet

Returns the IP config

Returns the current and stored IP configuration of the management port.


/device/ipconfig

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/ipconfig"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_10 result = apiInstance.deviceIpconfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIpconfigGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_10 result = apiInstance.deviceIpconfigGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIpconfigGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the IP config
[apiInstance deviceIpconfigGetWithCompletionHandler: 
              ^(inline_response_200_10 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceIpconfigGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceIpconfigGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the IP config
                inline_response_200_10 result = apiInstance.deviceIpconfigGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceIpconfigGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceIpconfigGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceIpconfigGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceIpconfigGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceIpconfigGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the IP config
    api_response = api_instance.device_ipconfig_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceIpconfigGet: %s\n" % e)

Parameters

Responses

Status: 200 - IP configuration information.

Status: default - Error state.


deviceIpconfigPost

Sets the IP config

Sets the current and stored (the one loaded on boot) IP configuration User level has to be higher or equal to SUPER.


/device/ipconfig

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/ipconfig?ip=&mask=&gw="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String ip = ip_example; // String | New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
        String mask = mask_example; // String | New network mask of the management port, e.g. '255.255.0.0'.
        String gw = gw_example; // String | New default gateway of the management port, e.g. '192.168.0.1'.
        try {
            Result result = apiInstance.deviceIpconfigPost(ip, mask, gw);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIpconfigPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String ip = ip_example; // String | New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
        String mask = mask_example; // String | New network mask of the management port, e.g. '255.255.0.0'.
        String gw = gw_example; // String | New default gateway of the management port, e.g. '192.168.0.1'.
        try {
            Result result = apiInstance.deviceIpconfigPost(ip, mask, gw);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceIpconfigPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *ip = ip_example; // New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
String *mask = mask_example; // New network mask of the management port, e.g. '255.255.0.0'.
String *gw = gw_example; // New default gateway of the management port, e.g. '192.168.0.1'.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the IP config
[apiInstance deviceIpconfigPostWith:ip
    mask:mask
    gw:gw
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var ip = ip_example; // {String} New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.

var mask = mask_example; // {String} New network mask of the management port, e.g. '255.255.0.0'.

var gw = gw_example; // {String} New default gateway of the management port, e.g. '192.168.0.1'.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceIpconfigPost(ip, mask, gw, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceIpconfigPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var ip = ip_example;  // String | New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
            var mask = mask_example;  // String | New network mask of the management port, e.g. '255.255.0.0'.
            var gw = gw_example;  // String | New default gateway of the management port, e.g. '192.168.0.1'.

            try
            {
                // Sets the IP config
                Result result = apiInstance.deviceIpconfigPost(ip, mask, gw);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceIpconfigPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$ip = ip_example; // String | New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
$mask = mask_example; // String | New network mask of the management port, e.g. '255.255.0.0'.
$gw = gw_example; // String | New default gateway of the management port, e.g. '192.168.0.1'.

try {
    $result = $api_instance->deviceIpconfigPost($ip, $mask, $gw);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceIpconfigPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $ip = ip_example; # String | New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
my $mask = mask_example; # String | New network mask of the management port, e.g. '255.255.0.0'.
my $gw = gw_example; # String | New default gateway of the management port, e.g. '192.168.0.1'.

eval { 
    my $result = $api_instance->deviceIpconfigPost(ip => $ip, mask => $mask, gw => $gw);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceIpconfigPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
ip = ip_example # String | New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
mask = mask_example # String | New network mask of the management port, e.g. '255.255.0.0'.
gw = gw_example # String | New default gateway of the management port, e.g. '192.168.0.1'.

try: 
    # Sets the IP config
    api_response = api_instance.device_ipconfig_post(ip, mask, gw)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceIpconfigPost: %s\n" % e)

Parameters

Query parameters
Name Description
ip*
String
New IP address of the management port, e.g. '192.168.0.200' or '169.254.254.42'.
Required
mask*
String
New network mask of the management port, e.g. '255.255.0.0'.
Required
gw*
String
New default gateway of the management port, e.g. '192.168.0.1'.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceLoadaverageGet

Returns load information

Returns various information about the load on the OS, namely CPU usage.


/device/loadaverage

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/loadaverage"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_11 result = apiInstance.deviceLoadaverageGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceLoadaverageGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_11 result = apiInstance.deviceLoadaverageGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceLoadaverageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns load information
[apiInstance deviceLoadaverageGetWithCompletionHandler: 
              ^(inline_response_200_11 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceLoadaverageGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceLoadaverageGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns load information
                inline_response_200_11 result = apiInstance.deviceLoadaverageGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceLoadaverageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceLoadaverageGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceLoadaverageGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceLoadaverageGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceLoadaverageGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns load information
    api_response = api_instance.device_loadaverage_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceLoadaverageGet: %s\n" % e)

Parameters

Responses

Status: 200 - Load information.

Status: default - Error state.


deviceMemoryusageGet

Returns memory usage

Returns total and free amount of memory.


/device/memoryusage

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/memoryusage"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_12 result = apiInstance.deviceMemoryusageGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceMemoryusageGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_12 result = apiInstance.deviceMemoryusageGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceMemoryusageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns memory usage
[apiInstance deviceMemoryusageGetWithCompletionHandler: 
              ^(inline_response_200_12 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceMemoryusageGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceMemoryusageGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns memory usage
                inline_response_200_12 result = apiInstance.deviceMemoryusageGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceMemoryusageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceMemoryusageGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceMemoryusageGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceMemoryusageGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceMemoryusageGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns memory usage
    api_response = api_instance.device_memoryusage_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceMemoryusageGet: %s\n" % e)

Parameters

Responses

Status: 200 - Memory usage information.

Status: default - Error state.


deviceModelGet

Returns the device model

Returns the device model.


/device/model

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/model"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_13 result = apiInstance.deviceModelGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceModelGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_13 result = apiInstance.deviceModelGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceModelGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the device model
[apiInstance deviceModelGetWithCompletionHandler: 
              ^(inline_response_200_13 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceModelGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceModelGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the device model
                inline_response_200_13 result = apiInstance.deviceModelGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceModelGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceModelGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceModelGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceModelGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceModelGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the device model
    api_response = api_instance.device_model_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceModelGet: %s\n" % e)

Parameters

Responses

Status: 200 - Device model information.

Status: default - Error state.


deviceNameGet

Returns the device label

Returns the device label used in the web UI.


/device/name

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/name"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_4 result = apiInstance.deviceNameGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNameGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_4 result = apiInstance.deviceNameGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNameGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the device label
[apiInstance deviceNameGetWithCompletionHandler: 
              ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceNameGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceNameGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the device label
                inline_response_200_4 result = apiInstance.deviceNameGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceNameGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceNameGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceNameGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the device label
    api_response = api_instance.device_name_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceNameGet: %s\n" % e)

Parameters

Responses

Status: 200 - Device label.

Status: default - Error state.


deviceNamePost

Sets the device label

Sets the device label used in the web UI, the one displayed in the right-left there. User level has to be higher or equal to SUPER.


/device/name

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/name?device_name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String deviceName = deviceName_example; // String | New device name.
        try {
            Result result = apiInstance.deviceNamePost(deviceName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNamePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String deviceName = deviceName_example; // String | New device name.
        try {
            Result result = apiInstance.deviceNamePost(deviceName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNamePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *deviceName = deviceName_example; // New device name.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the device label
[apiInstance deviceNamePostWith:deviceName
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var deviceName = deviceName_example; // {String} New device name.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceNamePost(deviceName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceNamePostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var deviceName = deviceName_example;  // String | New device name.

            try
            {
                // Sets the device label
                Result result = apiInstance.deviceNamePost(deviceName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceNamePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$deviceName = deviceName_example; // String | New device name.

try {
    $result = $api_instance->deviceNamePost($deviceName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceNamePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $deviceName = deviceName_example; # String | New device name.

eval { 
    my $result = $api_instance->deviceNamePost(deviceName => $deviceName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceNamePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
deviceName = deviceName_example # String | New device name.

try: 
    # Sets the device label
    api_response = api_instance.device_name_post(deviceName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceNamePost: %s\n" % e)

Parameters

Query parameters
Name Description
device_name*
String
New device name.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceNameresolutionGet

Sets name resolution settings

Returns the name resolution settings, namely the DNS servers.


/device/nameresolution

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/nameresolution"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_14 result = apiInstance.deviceNameresolutionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNameresolutionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_14 result = apiInstance.deviceNameresolutionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNameresolutionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets name resolution settings
[apiInstance deviceNameresolutionGetWithCompletionHandler: 
              ^(inline_response_200_14 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceNameresolutionGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceNameresolutionGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Sets name resolution settings
                inline_response_200_14 result = apiInstance.deviceNameresolutionGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceNameresolutionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceNameresolutionGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceNameresolutionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceNameresolutionGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceNameresolutionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Sets name resolution settings
    api_response = api_instance.device_nameresolution_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceNameresolutionGet: %s\n" % e)

Parameters

Responses

Status: 200 - DNS servers (up to three).

Status: default - Error state.


deviceNameresolutionPost

Sets the name resolution settings.

Sets the name resolution settings, namely the DNS servers. If empty sets to default values ("8.8.8.8" and "8.8.4.4") User level has to be higher or equal to SUPER.


/device/nameresolution

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/nameresolution?dns1=&dns2=&dns3="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String dns1 = dns1_example; // String | IP address of the first name server, e.g. `8.8.8.8`. It is queried first.
        String dns2 = dns2_example; // String | IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server.
        String dns3 = dns3_example; // String | IP address of the third name server. It is queried after the second server.
        try {
            Result result = apiInstance.deviceNameresolutionPost(dns1, dns2, dns3);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNameresolutionPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String dns1 = dns1_example; // String | IP address of the first name server, e.g. `8.8.8.8`. It is queried first.
        String dns2 = dns2_example; // String | IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server.
        String dns3 = dns3_example; // String | IP address of the third name server. It is queried after the second server.
        try {
            Result result = apiInstance.deviceNameresolutionPost(dns1, dns2, dns3);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceNameresolutionPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *dns1 = dns1_example; // IP address of the first name server, e.g. `8.8.8.8`. It is queried first. (optional)
String *dns2 = dns2_example; // IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server. (optional)
String *dns3 = dns3_example; // IP address of the third name server. It is queried after the second server. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the name resolution settings.
[apiInstance deviceNameresolutionPostWith:dns1
    dns2:dns2
    dns3:dns3
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var opts = { 
  'dns1': dns1_example, // {String} IP address of the first name server, e.g. `8.8.8.8`. It is queried first.
  'dns2': dns2_example, // {String} IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server.
  'dns3': dns3_example // {String} IP address of the third name server. It is queried after the second server.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceNameresolutionPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceNameresolutionPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var dns1 = dns1_example;  // String | IP address of the first name server, e.g. `8.8.8.8`. It is queried first. (optional) 
            var dns2 = dns2_example;  // String | IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server. (optional) 
            var dns3 = dns3_example;  // String | IP address of the third name server. It is queried after the second server. (optional) 

            try
            {
                // Sets the name resolution settings.
                Result result = apiInstance.deviceNameresolutionPost(dns1, dns2, dns3);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceNameresolutionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$dns1 = dns1_example; // String | IP address of the first name server, e.g. `8.8.8.8`. It is queried first.
$dns2 = dns2_example; // String | IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server.
$dns3 = dns3_example; // String | IP address of the third name server. It is queried after the second server.

try {
    $result = $api_instance->deviceNameresolutionPost($dns1, $dns2, $dns3);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceNameresolutionPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $dns1 = dns1_example; # String | IP address of the first name server, e.g. `8.8.8.8`. It is queried first.
my $dns2 = dns2_example; # String | IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server.
my $dns3 = dns3_example; # String | IP address of the third name server. It is queried after the second server.

eval { 
    my $result = $api_instance->deviceNameresolutionPost(dns1 => $dns1, dns2 => $dns2, dns3 => $dns3);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceNameresolutionPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
dns1 = dns1_example # String | IP address of the first name server, e.g. `8.8.8.8`. It is queried first. (optional)
dns2 = dns2_example # String | IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server. (optional)
dns3 = dns3_example # String | IP address of the third name server. It is queried after the second server. (optional)

try: 
    # Sets the name resolution settings.
    api_response = api_instance.device_nameresolution_post(dns1=dns1, dns2=dns2, dns3=dns3)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceNameresolutionPost: %s\n" % e)

Parameters

Query parameters
Name Description
dns1
String
IP address of the first name server, e.g. `8.8.8.8`. It is queried first.
dns2
String
IP address of the second name server, e.g. `8.8.4.4`. It is queried after the first server.
dns3
String
IP address of the third name server. It is queried after the second server.

Responses

Status: 200 - Result state.

Status: default - Error state.


devicePermanentrulesmodeGet

Returns state of permanent mode

Returns the state of the permanent mode. Permanent mode means that the active rules/groups are always permanent and remain throughout reboots.


/device/permanentrulesmode

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/permanentrulesmode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_15 result = apiInstance.devicePermanentrulesmodeGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#devicePermanentrulesmodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_15 result = apiInstance.devicePermanentrulesmodeGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#devicePermanentrulesmodeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns state of permanent mode
[apiInstance devicePermanentrulesmodeGetWithCompletionHandler: 
              ^(inline_response_200_15 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.devicePermanentrulesmodeGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class devicePermanentrulesmodeGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns state of permanent mode
                inline_response_200_15 result = apiInstance.devicePermanentrulesmodeGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.devicePermanentrulesmodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->devicePermanentrulesmodeGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->devicePermanentrulesmodeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->devicePermanentrulesmodeGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->devicePermanentrulesmodeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns state of permanent mode
    api_response = api_instance.device_permanentrulesmode_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->devicePermanentrulesmodeGet: %s\n" % e)

Parameters

Responses

Status: 200 - Permanent rules mode.

Status: default - Error state.


devicePermanentrulesmodePost

Sets the permanent mode

Sets the permanent mode. User level has to be higher or equal to SUPER.


/device/permanentrulesmode

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/permanentrulesmode?state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Boolean state = true; // Boolean | New state of permanent mode, true = on.
        try {
            Result result = apiInstance.devicePermanentrulesmodePost(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#devicePermanentrulesmodePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Boolean state = true; // Boolean | New state of permanent mode, true = on.
        try {
            Result result = apiInstance.devicePermanentrulesmodePost(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#devicePermanentrulesmodePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Boolean *state = true; // New state of permanent mode, true = on.

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the permanent mode
[apiInstance devicePermanentrulesmodePostWith:state
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var state = true; // {Boolean} New state of permanent mode, true = on.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.devicePermanentrulesmodePost(state, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class devicePermanentrulesmodePostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var state = true;  // Boolean | New state of permanent mode, true = on.

            try
            {
                // Sets the permanent mode
                Result result = apiInstance.devicePermanentrulesmodePost(state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.devicePermanentrulesmodePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$state = true; // Boolean | New state of permanent mode, true = on.

try {
    $result = $api_instance->devicePermanentrulesmodePost($state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->devicePermanentrulesmodePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $state = true; # Boolean | New state of permanent mode, true = on.

eval { 
    my $result = $api_instance->devicePermanentrulesmodePost(state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->devicePermanentrulesmodePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
state = true # Boolean | New state of permanent mode, true = on.

try: 
    # Sets the permanent mode
    api_response = api_instance.device_permanentrulesmode_post(state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->devicePermanentrulesmodePost: %s\n" % e)

Parameters

Query parameters
Name Description
state*
Boolean
New state of permanent mode, true = on.
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceRebootPost

Device reboot

Reboots the device right away. User level has to be higher or equal to SUPER.


/device/reboot

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/reboot"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            Result result = apiInstance.deviceRebootPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRebootPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            Result result = apiInstance.deviceRebootPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRebootPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Device reboot
[apiInstance deviceRebootPostWithCompletionHandler: 
              ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceRebootPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceRebootPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Device reboot
                Result result = apiInstance.deviceRebootPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceRebootPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceRebootPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceRebootPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceRebootPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceRebootPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Device reboot
    api_response = api_instance.device_reboot_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceRebootPost: %s\n" % e)

Parameters

Responses

Status: 200 - Result state (device might reboot before returning it)

Status: default - Error state.


deviceRestartwebserverPost

Restarts the webserver without a reboot.

Restarts the webserver right away. User level has to be higher or equal to SUPER.


/device/restartwebserver

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/restartwebserver"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            Result result = apiInstance.deviceRestartwebserverPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRestartwebserverPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            Result result = apiInstance.deviceRestartwebserverPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRestartwebserverPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Restarts the webserver without a reboot.
[apiInstance deviceRestartwebserverPostWithCompletionHandler: 
              ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceRestartwebserverPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceRestartwebserverPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Restarts the webserver without a reboot.
                Result result = apiInstance.deviceRestartwebserverPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceRestartwebserverPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceRestartwebserverPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceRestartwebserverPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceRestartwebserverPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceRestartwebserverPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Restarts the webserver without a reboot.
    api_response = api_instance.device_restartwebserver_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceRestartwebserverPost: %s\n" % e)

Parameters

Responses

Status: 200 - Result state (webserver might be restarting before returning it)

Status: default - Error state.


deviceRulestoragemodeGet

Returns the rule storage mode setting

Returns the rule storage mode setting.


/device/rulestoragemode

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/rulestoragemode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_16 result = apiInstance.deviceRulestoragemodeGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRulestoragemodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_16 result = apiInstance.deviceRulestoragemodeGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRulestoragemodeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the rule storage mode setting
[apiInstance deviceRulestoragemodeGetWithCompletionHandler: 
              ^(inline_response_200_16 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceRulestoragemodeGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceRulestoragemodeGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the rule storage mode setting
                inline_response_200_16 result = apiInstance.deviceRulestoragemodeGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceRulestoragemodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceRulestoragemodeGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceRulestoragemodeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceRulestoragemodeGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceRulestoragemodeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the rule storage mode setting
    api_response = api_instance.device_rulestoragemode_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceRulestoragemodeGet: %s\n" % e)

Parameters

Responses

Status: 200 - Rule storage mode ("simple"/"ipv6").

Status: default - Error state.


deviceRulestoragemodePost

Sets the rule storage mode

Sets the rule storage mode, might affect the matching and action capabilities of some devices, e.g. concerning IPv6. User level has to be higher or equal to SUPER.


/device/rulestoragemode

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/rulestoragemode?mode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Super_Rights_Required
        HttpBasicAuth Super_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Super_Rights_Required");
        Super_Rights_Required.setUsername("YOUR USERNAME");
        Super_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String mode = mode_example; // String | New rule storage mode ('simple' or 'ipv6').
        try {
            inline_response_200_17 result = apiInstance.deviceRulestoragemodePost(mode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRulestoragemodePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String mode = mode_example; // String | New rule storage mode ('simple' or 'ipv6').
        try {
            inline_response_200_17 result = apiInstance.deviceRulestoragemodePost(mode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceRulestoragemodePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Super_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *mode = mode_example; // New rule storage mode ('simple' or 'ipv6').

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Sets the rule storage mode
[apiInstance deviceRulestoragemodePostWith:mode
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var mode = mode_example; // {String} New rule storage mode ('simple' or 'ipv6').


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceRulestoragemodePost(mode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceRulestoragemodePostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Super_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var mode = mode_example;  // String | New rule storage mode ('simple' or 'ipv6').

            try
            {
                // Sets the rule storage mode
                inline_response_200_17 result = apiInstance.deviceRulestoragemodePost(mode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceRulestoragemodePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Super_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$mode = mode_example; // String | New rule storage mode ('simple' or 'ipv6').

try {
    $result = $api_instance->deviceRulestoragemodePost($mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceRulestoragemodePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Super_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $mode = mode_example; # String | New rule storage mode ('simple' or 'ipv6').

eval { 
    my $result = $api_instance->deviceRulestoragemodePost(mode => $mode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceRulestoragemodePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Super_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
mode = mode_example # String | New rule storage mode ('simple' or 'ipv6').

try: 
    # Sets the rule storage mode
    api_response = api_instance.device_rulestoragemode_post(mode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceRulestoragemodePost: %s\n" % e)

Parameters

Query parameters
Name Description
mode*
String
New rule storage mode ('simple' or 'ipv6').
Required

Responses

Status: 200 - Rule storage mode ('simple' or 'ipv6').

Status: default - Error state.


deviceSerialnoGet

Returns the serial number

Returns the serial number of the device.


/device/serialno

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/serialno"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_18 result = apiInstance.deviceSerialnoGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceSerialnoGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_18 result = apiInstance.deviceSerialnoGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceSerialnoGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the serial number
[apiInstance deviceSerialnoGetWithCompletionHandler: 
              ^(inline_response_200_18 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceSerialnoGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceSerialnoGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the serial number
                inline_response_200_18 result = apiInstance.deviceSerialnoGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceSerialnoGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceSerialnoGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceSerialnoGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceSerialnoGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceSerialnoGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the serial number
    api_response = api_instance.device_serialno_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceSerialnoGet: %s\n" % e)

Parameters

Responses

Status: 200 - Serial number information.

Status: default - Error state.


deviceServerrevisionGet

Returns the revision

Returns the revision.


/device/serverrevision

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/serverrevision"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_19 result = apiInstance.deviceServerrevisionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceServerrevisionGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_19 result = apiInstance.deviceServerrevisionGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceServerrevisionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the revision
[apiInstance deviceServerrevisionGetWithCompletionHandler: 
              ^(inline_response_200_19 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceServerrevisionGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceServerrevisionGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the revision
                inline_response_200_19 result = apiInstance.deviceServerrevisionGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceServerrevisionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceServerrevisionGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceServerrevisionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceServerrevisionGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceServerrevisionGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the revision
    api_response = api_instance.device_serverrevision_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceServerrevisionGet: %s\n" % e)

Parameters

Responses

Status: 200 - Revision information.

Status: default - Error state.


deviceSetlicensePost

Adds a license for this device

Adds and validates a license for this device


/device/setlicense

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/setlicense?id=&validUntil=&serialNumber=&signature="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Boolean id = true; // Boolean | ID of the license
        Boolean validUntil = true; // Boolean | date until the license is valid. Is not verified here. E.g. "2019-09-07"
        Boolean serialNumber = true; // Boolean | Serial number of the device. Needs to be the same as the serial number on this device
        Boolean signature = true; // Boolean | base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))
        try {
            Result result = apiInstance.deviceSetlicensePost(id, validUntil, serialNumber, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceSetlicensePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Boolean id = true; // Boolean | ID of the license
        Boolean validUntil = true; // Boolean | date until the license is valid. Is not verified here. E.g. "2019-09-07"
        Boolean serialNumber = true; // Boolean | Serial number of the device. Needs to be the same as the serial number on this device
        Boolean signature = true; // Boolean | base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))
        try {
            Result result = apiInstance.deviceSetlicensePost(id, validUntil, serialNumber, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceSetlicensePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Boolean *id = true; // ID of the license
Boolean *validUntil = true; // date until the license is valid. Is not verified here. E.g. "2019-09-07"
Boolean *serialNumber = true; // Serial number of the device. Needs to be the same as the serial number on this device
Boolean *signature = true; // base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Adds a license for this device
[apiInstance deviceSetlicensePostWith:id
    validUntil:validUntil
    serialNumber:serialNumber
    signature:signature
              completionHandler: ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var id = true; // {Boolean} ID of the license

var validUntil = true; // {Boolean} date until the license is valid. Is not verified here. E.g. "2019-09-07"

var serialNumber = true; // {Boolean} Serial number of the device. Needs to be the same as the serial number on this device

var signature = true; // {Boolean} base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceSetlicensePost(id, validUntil, serialNumber, signature, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceSetlicensePostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var id = true;  // Boolean | ID of the license
            var validUntil = true;  // Boolean | date until the license is valid. Is not verified here. E.g. "2019-09-07"
            var serialNumber = true;  // Boolean | Serial number of the device. Needs to be the same as the serial number on this device
            var signature = true;  // Boolean | base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))

            try
            {
                // Adds a license for this device
                Result result = apiInstance.deviceSetlicensePost(id, validUntil, serialNumber, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceSetlicensePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();
$id = true; // Boolean | ID of the license
$validUntil = true; // Boolean | date until the license is valid. Is not verified here. E.g. "2019-09-07"
$serialNumber = true; // Boolean | Serial number of the device. Needs to be the same as the serial number on this device
$signature = true; // Boolean | base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))

try {
    $result = $api_instance->deviceSetlicensePost($id, $validUntil, $serialNumber, $signature);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceSetlicensePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $id = true; # Boolean | ID of the license
my $validUntil = true; # Boolean | date until the license is valid. Is not verified here. E.g. "2019-09-07"
my $serialNumber = true; # Boolean | Serial number of the device. Needs to be the same as the serial number on this device
my $signature = true; # Boolean | base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))

eval { 
    my $result = $api_instance->deviceSetlicensePost(id => $id, validUntil => $validUntil, serialNumber => $serialNumber, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceSetlicensePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
id = true # Boolean | ID of the license
validUntil = true # Boolean | date until the license is valid. Is not verified here. E.g. "2019-09-07"
serialNumber = true # Boolean | Serial number of the device. Needs to be the same as the serial number on this device
signature = true # Boolean | base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))

try: 
    # Adds a license for this device
    api_response = api_instance.device_setlicense_post(id, validUntil, serialNumber, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceSetlicensePost: %s\n" % e)

Parameters

Query parameters
Name Description
id*
Boolean
ID of the license
Required
validUntil*
Boolean
date until the license is valid. Is not verified here. E.g. "2019-09-07"
Required
serialNumber*
Boolean
Serial number of the device. Needs to be the same as the serial number on this device
Required
signature*
Boolean
base64(md5(id+";"+serialNumber+";"+validUntil+";"+signature))
Required

Responses

Status: 200 - Result state.

Status: default - Error state.


deviceTelnetGet

Gets the device ID LED status

Shows whether the device ID LED is activated or not


/device/telnet

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/telnet"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_8 result = apiInstance.deviceTelnetGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceTelnetGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_8 result = apiInstance.deviceTelnetGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceTelnetGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Gets the device ID LED status
[apiInstance deviceTelnetGetWithCompletionHandler: 
              ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceTelnetGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceTelnetGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Gets the device ID LED status
                inline_response_200_8 result = apiInstance.deviceTelnetGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceTelnetGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceTelnetGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceTelnetGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceTelnetGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceTelnetGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Gets the device ID LED status
    api_response = api_instance.device_telnet_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceTelnetGet: %s\n" % e)

Parameters

Responses

Status: 200 - Result state.


deviceTelnetPost

Gets the device ID LED status

Shows whether the device ID LED is activated or not


/device/telnet

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/device/telnet"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_8 result = apiInstance.deviceTelnetPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceTelnetPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_8 result = apiInstance.deviceTelnetPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deviceTelnetPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Gets the device ID LED status
[apiInstance deviceTelnetPostWithCompletionHandler: 
              ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deviceTelnetPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deviceTelnetPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Gets the device ID LED status
                inline_response_200_8 result = apiInstance.deviceTelnetPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deviceTelnetPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->deviceTelnetPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deviceTelnetPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->deviceTelnetPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deviceTelnetPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Gets the device ID LED status
    api_response = api_instance.device_telnet_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deviceTelnetPost: %s\n" % e)

Parameters

Responses

Status: 200 - Result state.


flownumbersGet

Returns the maximum and currently used amount of TCAM flows

Returns the maximum and currently used amount of TCAM flows. (Note that the maximum is only a lower bound of what is at least supported by all rules possible, depending on the rules overstepping it to some extend it might still be possible.)


/flownumbers

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/flownumbers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_20 result = apiInstance.flownumbersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#flownumbersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_20 result = apiInstance.flownumbersGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#flownumbersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns the maximum and currently used amount of TCAM flows
[apiInstance flownumbersGetWithCompletionHandler: 
              ^(inline_response_200_20 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.flownumbersGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class flownumbersGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns the maximum and currently used amount of TCAM flows
                inline_response_200_20 result = apiInstance.flownumbersGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.flownumbersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->flownumbersGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->flownumbersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->flownumbersGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->flownumbersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns the maximum and currently used amount of TCAM flows
    api_response = api_instance.flownumbers_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->flownumbersGet: %s\n" % e)

Parameters

Responses

Status: 200 - TCAM flow count info.

Status: default - Error state.


groupsAllDelete

Deletes all active groups

Deletes all active groups. Also deletes all rules which have any group as an action. User level has to be higher or equal to WRITE.


/groups/all

Usage and SDK Samples

curl -X DELETE -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/groups/all"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Write_Rights_Required
        HttpBasicAuth Write_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Write_Rights_Required");
        Write_Rights_Required.setUsername("YOUR USERNAME");
        Write_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            Result result = apiInstance.groupsAllDelete();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#groupsAllDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            Result result = apiInstance.groupsAllDelete();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#groupsAllDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Write_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Deletes all active groups
[apiInstance groupsAllDeleteWithCompletionHandler: 
              ^(Result output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsAllDelete(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class groupsAllDeleteExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Write_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Deletes all active groups
                Result result = apiInstance.groupsAllDelete();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.groupsAllDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Write_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->groupsAllDelete();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->groupsAllDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Write_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->groupsAllDelete();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->groupsAllDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Write_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Deletes all active groups
    api_response = api_instance.groups_all_delete()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->groupsAllDelete: %s\n" % e)

Parameters

Responses

Status: 200 - Result state.

Status: default - Error state.


groupsAllGet

Returns all currently active groups on the device

Returns all currently active groups on the device.


/groups/all

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/rest/groups/all"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: Read_Rights_Required
        HttpBasicAuth Read_Rights_Required = (HttpBasicAuth) defaultClient.getAuthentication("Read_Rights_Required");
        Read_Rights_Required.setUsername("YOUR USERNAME");
        Read_Rights_Required.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_21 result = apiInstance.groupsAllGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#groupsAllGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_21 result = apiInstance.groupsAllGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#groupsAllGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: Read_Rights_Required)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Returns all currently active groups on the device
[apiInstance groupsAllGetWithCompletionHandler: 
              ^(inline_response_200_21 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ExWuiRestApiDocumentation = require('ex_wui_rest_api_documentation');
var defaultClient = ExWuiRestApiDocumentation.ApiClient.instance;

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

var api = new ExWuiRestApiDocumentation.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsAllGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class groupsAllGetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: Read_Rights_Required
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                // Returns all currently active groups on the device
                inline_response_200_21 result = apiInstance.groupsAllGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.groupsAllGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: Read_Rights_Required
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $result = $api_instance->groupsAllGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->groupsAllGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure HTTP basic authorization: Read_Rights_Required
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->groupsAllGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->groupsAllGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: Read_Rights_Required
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Returns all currently active groups on the device
    api_response = api_instance.groups_all_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->groupsAllGet: %s\n" % e)

Parameters

Responses

Status: 200 - Object with active groups.

Status: default - Error state.