uCentral gateway API

Blacklist

createBlackListDevice

Create to the blacklist.


/blacklist/{serialNumber}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/blacklist/{serialNumber}" \
 -d '{
  "reason" : "reason",
  "serialNumber" : "serialNumber",
  "created" : 0,
  "author" : "author"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BlacklistApi;

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

public class BlacklistApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)
        BlackDeviceInfo blackDeviceInfo = ; // BlackDeviceInfo | 

        try {
            apiInstance.createBlackListDevice(serialNumber, blackDeviceInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#createBlackListDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.BlacklistApi;

public class BlacklistApiExample {
    public static void main(String[] args) {
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)
        BlackDeviceInfo blackDeviceInfo = ; // BlackDeviceInfo | 

        try {
            apiInstance.createBlackListDevice(serialNumber, blackDeviceInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#createBlackListDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BlacklistApi *apiInstance = [[BlacklistApi alloc] init];
String *serialNumber = serialNumber_example; // Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)
BlackDeviceInfo *blackDeviceInfo = ; //  (optional)

// Create to the blacklist.
[apiInstance createBlackListDeviceWith:serialNumber
    blackDeviceInfo:blackDeviceInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.BlacklistApi()
var serialNumber = serialNumber_example; // {String} Pagination start (starts at 1. If not specified, 1 is assumed)
var opts = {
  'blackDeviceInfo':  // {BlackDeviceInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createBlackListDevice(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createBlackListDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BlacklistApi();
            var serialNumber = serialNumber_example;  // String | Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)
            var blackDeviceInfo = new BlackDeviceInfo(); // BlackDeviceInfo |  (optional) 

            try {
                // Create to the blacklist.
                apiInstance.createBlackListDevice(serialNumber, blackDeviceInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling BlacklistApi.createBlackListDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BlacklistApi();
$serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)
$blackDeviceInfo = ; // BlackDeviceInfo | 

try {
    $api_instance->createBlackListDevice($serialNumber, $blackDeviceInfo);
} catch (Exception $e) {
    echo 'Exception when calling BlacklistApi->createBlackListDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BlacklistApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BlacklistApi->new();
my $serialNumber = serialNumber_example; # String | Pagination start (starts at 1. If not specified, 1 is assumed)
my $blackDeviceInfo = WWW::OPenAPIClient::Object::BlackDeviceInfo->new(); # BlackDeviceInfo | 

eval {
    $api_instance->createBlackListDevice(serialNumber => $serialNumber, blackDeviceInfo => $blackDeviceInfo);
};
if ($@) {
    warn "Exception when calling BlacklistApi->createBlackListDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BlacklistApi()
serialNumber = serialNumber_example # String | Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)
blackDeviceInfo =  # BlackDeviceInfo |  (optional)

try:
    # Create to the blacklist.
    api_instance.create_black_list_device(serialNumber, blackDeviceInfo=blackDeviceInfo)
except ApiException as e:
    print("Exception when calling BlacklistApi->createBlackListDevice: %s\n" % e)
extern crate BlacklistApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let blackDeviceInfo = ; // BlackDeviceInfo

    let mut context = BlacklistApi::Context::default();
    let result = client.createBlackListDevice(serialNumber, blackDeviceInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Pagination start (starts at 1. If not specified, 1 is assumed)
Required
Body parameters
Name Description
blackDeviceInfo

Add blacklisted device

Responses

deleteFromBlackList

Delete from the blacklist.


/blacklist/{serialNumber}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/blacklist/{serialNumber}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BlacklistApi;

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

public class BlacklistApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            apiInstance.deleteFromBlackList(serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#deleteFromBlackList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.BlacklistApi;

public class BlacklistApiExample {
    public static void main(String[] args) {
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            apiInstance.deleteFromBlackList(serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#deleteFromBlackList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BlacklistApi *apiInstance = [[BlacklistApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Delete from the blacklist.
[apiInstance deleteFromBlackListWith:serialNumber
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.BlacklistApi()
var serialNumber = serialNumber_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFromBlackList(serialNumber, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteFromBlackListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BlacklistApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Delete from the blacklist.
                apiInstance.deleteFromBlackList(serialNumber);
            } catch (Exception e) {
                Debug.Print("Exception when calling BlacklistApi.deleteFromBlackList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BlacklistApi();
$serialNumber = serialNumber_example; // String | 

try {
    $api_instance->deleteFromBlackList($serialNumber);
} catch (Exception $e) {
    echo 'Exception when calling BlacklistApi->deleteFromBlackList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BlacklistApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BlacklistApi->new();
my $serialNumber = serialNumber_example; # String | 

eval {
    $api_instance->deleteFromBlackList(serialNumber => $serialNumber);
};
if ($@) {
    warn "Exception when calling BlacklistApi->deleteFromBlackList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BlacklistApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Delete from the blacklist.
    api_instance.delete_from_black_list(serialNumber)
except ApiException as e:
    print("Exception when calling BlacklistApi->deleteFromBlackList: %s\n" % e)
extern crate BlacklistApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = BlacklistApi::Context::default();
    let result = client.deleteFromBlackList(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

getBlacklistDevice

Returns a blacklist entry.

Get a list of blacklisted devices.


/blacklist/{serialNumber}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/blacklist/{serialNumber}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BlacklistApi;

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

public class BlacklistApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)

        try {
            BlackDeviceInfo result = apiInstance.getBlacklistDevice(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#getBlacklistDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.BlacklistApi;

public class BlacklistApiExample {
    public static void main(String[] args) {
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)

        try {
            BlackDeviceInfo result = apiInstance.getBlacklistDevice(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#getBlacklistDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BlacklistApi *apiInstance = [[BlacklistApi alloc] init];
String *serialNumber = serialNumber_example; // Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)

// Returns a blacklist entry.
[apiInstance getBlacklistDeviceWith:serialNumber
              completionHandler: ^(BlackDeviceInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.BlacklistApi()
var serialNumber = serialNumber_example; // {String} Pagination start (starts at 1. If not specified, 1 is assumed)

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBlacklistDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BlacklistApi();
            var serialNumber = serialNumber_example;  // String | Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)

            try {
                // Returns a blacklist entry.
                BlackDeviceInfo result = apiInstance.getBlacklistDevice(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BlacklistApi.getBlacklistDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BlacklistApi();
$serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BlacklistApi->new();
my $serialNumber = serialNumber_example; # String | Pagination start (starts at 1. If not specified, 1 is assumed)

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BlacklistApi()
serialNumber = serialNumber_example # String | Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)

try:
    # Returns a blacklist entry.
    api_response = api_instance.get_blacklist_device(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlacklistApi->getBlacklistDevice: %s\n" % e)
extern crate BlacklistApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = BlacklistApi::Context::default();
    let result = client.getBlacklistDevice(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Pagination start (starts at 1. If not specified, 1 is assumed)
Required

Responses

getBlacklistDeviceList

Returns a list blacklisted devices.

Get a list of blacklisted devices.


/blacklist

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/blacklist?offset=56&limit=56&filter=filter_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BlacklistApi;

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

public class BlacklistApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BlacklistApi apiInstance = new BlacklistApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results

        try {
            BlackDeviceList result = apiInstance.getBlacklistDeviceList(offset, limit, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#getBlacklistDeviceList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.BlacklistApi;

public class BlacklistApiExample {
    public static void main(String[] args) {
        BlacklistApi apiInstance = new BlacklistApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results

        try {
            BlackDeviceList result = apiInstance.getBlacklistDeviceList(offset, limit, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#getBlacklistDeviceList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BlacklistApi *apiInstance = [[BlacklistApi alloc] init];
Integer *offset = 56; // Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *filter = filter_example; // Filter the results (optional) (default to null)

// Returns a list blacklisted devices.
[apiInstance getBlacklistDeviceListWith:offset
    limit:limit
    filter:filter
              completionHandler: ^(BlackDeviceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.BlacklistApi()
var opts = {
  'offset': 56, // {Integer} Pagination start (starts at 1. If not specified, 1 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'filter': filter_example // {String} Filter the results
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBlacklistDeviceListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BlacklistApi();
            var offset = 56;  // Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var filter = filter_example;  // String | Filter the results (optional)  (default to null)

            try {
                // Returns a list blacklisted devices.
                BlackDeviceList result = apiInstance.getBlacklistDeviceList(offset, limit, filter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BlacklistApi.getBlacklistDeviceList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BlacklistApi();
$offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$filter = filter_example; // String | Filter the results

try {
    $result = $api_instance->getBlacklistDeviceList($offset, $limit, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlacklistApi->getBlacklistDeviceList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BlacklistApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BlacklistApi->new();
my $offset = 56; # Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $filter = filter_example; # String | Filter the results

eval {
    my $result = $api_instance->getBlacklistDeviceList(offset => $offset, limit => $limit, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlacklistApi->getBlacklistDeviceList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BlacklistApi()
offset = 56 # Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
filter = filter_example # String | Filter the results (optional) (default to null)

try:
    # Returns a list blacklisted devices.
    api_response = api_instance.get_blacklist_device_list(offset=offset, limit=limit, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlacklistApi->getBlacklistDeviceList: %s\n" % e)
extern crate BlacklistApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String

    let mut context = BlacklistApi::Context::default();
    let result = client.getBlacklistDeviceList(offset, limit, filter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Pagination start (starts at 1. If not specified, 1 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
filter
String
Filter the results

Responses

modifyBlackList

Modify to the blacklist.


/blacklist/{serialNumber}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/blacklist/{serialNumber}" \
 -d '{
  "reason" : "reason",
  "serialNumber" : "serialNumber",
  "created" : 0,
  "author" : "author"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BlacklistApi;

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

public class BlacklistApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)
        BlackDeviceInfo blackDeviceInfo = ; // BlackDeviceInfo | 

        try {
            apiInstance.modifyBlackList(serialNumber, blackDeviceInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#modifyBlackList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.BlacklistApi;

public class BlacklistApiExample {
    public static void main(String[] args) {
        BlacklistApi apiInstance = new BlacklistApi();
        String serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)
        BlackDeviceInfo blackDeviceInfo = ; // BlackDeviceInfo | 

        try {
            apiInstance.modifyBlackList(serialNumber, blackDeviceInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlacklistApi#modifyBlackList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BlacklistApi *apiInstance = [[BlacklistApi alloc] init];
String *serialNumber = serialNumber_example; // Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)
BlackDeviceInfo *blackDeviceInfo = ; //  (optional)

// Modify to the blacklist.
[apiInstance modifyBlackListWith:serialNumber
    blackDeviceInfo:blackDeviceInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.BlacklistApi()
var serialNumber = serialNumber_example; // {String} Pagination start (starts at 1. If not specified, 1 is assumed)
var opts = {
  'blackDeviceInfo':  // {BlackDeviceInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyBlackList(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyBlackListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BlacklistApi();
            var serialNumber = serialNumber_example;  // String | Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)
            var blackDeviceInfo = new BlackDeviceInfo(); // BlackDeviceInfo |  (optional) 

            try {
                // Modify to the blacklist.
                apiInstance.modifyBlackList(serialNumber, blackDeviceInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling BlacklistApi.modifyBlackList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BlacklistApi();
$serialNumber = serialNumber_example; // String | Pagination start (starts at 1. If not specified, 1 is assumed)
$blackDeviceInfo = ; // BlackDeviceInfo | 

try {
    $api_instance->modifyBlackList($serialNumber, $blackDeviceInfo);
} catch (Exception $e) {
    echo 'Exception when calling BlacklistApi->modifyBlackList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BlacklistApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BlacklistApi->new();
my $serialNumber = serialNumber_example; # String | Pagination start (starts at 1. If not specified, 1 is assumed)
my $blackDeviceInfo = WWW::OPenAPIClient::Object::BlackDeviceInfo->new(); # BlackDeviceInfo | 

eval {
    $api_instance->modifyBlackList(serialNumber => $serialNumber, blackDeviceInfo => $blackDeviceInfo);
};
if ($@) {
    warn "Exception when calling BlacklistApi->modifyBlackList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BlacklistApi()
serialNumber = serialNumber_example # String | Pagination start (starts at 1. If not specified, 1 is assumed) (default to null)
blackDeviceInfo =  # BlackDeviceInfo |  (optional)

try:
    # Modify to the blacklist.
    api_instance.modify_black_list(serialNumber, blackDeviceInfo=blackDeviceInfo)
except ApiException as e:
    print("Exception when calling BlacklistApi->modifyBlackList: %s\n" % e)
extern crate BlacklistApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let blackDeviceInfo = ; // BlackDeviceInfo

    let mut context = BlacklistApi::Context::default();
    let result = client.modifyBlackList(serialNumber, blackDeviceInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Pagination start (starts at 1. If not specified, 1 is assumed)
Required
Body parameters
Name Description
blackDeviceInfo

Add blacklisted devices

Responses

Commands

createConfigurationForADevice

Configure a device.


/device/{serialNumber}/ping

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/ping" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        CreateConfigurationForADeviceRequest createConfigurationForADeviceRequest = ; // CreateConfigurationForADeviceRequest | 

        try {
            createConfigurationForADevice_200_response result = apiInstance.createConfigurationForADevice(serialNumber, createConfigurationForADeviceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#createConfigurationForADevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        CreateConfigurationForADeviceRequest createConfigurationForADeviceRequest = ; // CreateConfigurationForADeviceRequest | 

        try {
            createConfigurationForADevice_200_response result = apiInstance.createConfigurationForADevice(serialNumber, createConfigurationForADeviceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#createConfigurationForADevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
CreateConfigurationForADeviceRequest *createConfigurationForADeviceRequest = ; //  (optional)

// Configure a device.
[apiInstance createConfigurationForADeviceWith:serialNumber
    createConfigurationForADeviceRequest:createConfigurationForADeviceRequest
              completionHandler: ^(createConfigurationForADevice_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'createConfigurationForADeviceRequest':  // {CreateConfigurationForADeviceRequest} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createConfigurationForADeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var createConfigurationForADeviceRequest = new CreateConfigurationForADeviceRequest(); // CreateConfigurationForADeviceRequest |  (optional) 

            try {
                // Configure a device.
                createConfigurationForADevice_200_response result = apiInstance.createConfigurationForADevice(serialNumber, createConfigurationForADeviceRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.createConfigurationForADevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$createConfigurationForADeviceRequest = ; // CreateConfigurationForADeviceRequest | 

try {
    $result = $api_instance->createConfigurationForADevice($serialNumber, $createConfigurationForADeviceRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->createConfigurationForADevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $createConfigurationForADeviceRequest = WWW::OPenAPIClient::Object::CreateConfigurationForADeviceRequest->new(); # CreateConfigurationForADeviceRequest | 

eval {
    my $result = $api_instance->createConfigurationForADevice(serialNumber => $serialNumber, createConfigurationForADeviceRequest => $createConfigurationForADeviceRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->createConfigurationForADevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
createConfigurationForADeviceRequest =  # CreateConfigurationForADeviceRequest |  (optional)

try:
    # Configure a device.
    api_response = api_instance.create_configuration_for_a_device(serialNumber, createConfigurationForADeviceRequest=createConfigurationForADeviceRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->createConfigurationForADevice: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let createConfigurationForADeviceRequest = ; // CreateConfigurationForADeviceRequest

    let mut context = CommandsApi::Context::default();
    let result = client.createConfigurationForADevice(serialNumber, createConfigurationForADeviceRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
createConfigurationForADeviceRequest

Command details

Responses

debugDevice

Debug a device.


/device/{serialNumber}/script

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/script" \
 -d '{
  "deferred" : true,
  "scriptId" : "scriptId",
  "serialNumber" : "serialNumber",
  "signature" : "signature",
  "type" : "shell",
  "when" : 6,
  "uri" : "uri",
  "timeout" : 0,
  "script" : "script"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        ScriptRequest scriptRequest = ; // ScriptRequest | 

        try {
            apiInstance.debugDevice(serialNumber, scriptRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#debugDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        ScriptRequest scriptRequest = ; // ScriptRequest | 

        try {
            apiInstance.debugDevice(serialNumber, scriptRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#debugDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
ScriptRequest *scriptRequest = ; //  (optional)

// Debug a device.
[apiInstance debugDeviceWith:serialNumber
    scriptRequest:scriptRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'scriptRequest':  // {ScriptRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.debugDevice(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class debugDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var scriptRequest = new ScriptRequest(); // ScriptRequest |  (optional) 

            try {
                // Debug a device.
                apiInstance.debugDevice(serialNumber, scriptRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.debugDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$scriptRequest = ; // ScriptRequest | 

try {
    $api_instance->debugDevice($serialNumber, $scriptRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->debugDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $scriptRequest = WWW::OPenAPIClient::Object::ScriptRequest->new(); # ScriptRequest | 

eval {
    $api_instance->debugDevice(serialNumber => $serialNumber, scriptRequest => $scriptRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->debugDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
scriptRequest =  # ScriptRequest |  (optional)

try:
    # Debug a device.
    api_instance.debug_device(serialNumber, scriptRequest=scriptRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->debugDevice: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let scriptRequest = ; // ScriptRequest

    let mut context = CommandsApi::Context::default();
    let result = client.debugDevice(serialNumber, scriptRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
scriptRequest

Command details

Responses

deleteACommand

Delete a specific command.

Delete a specific command


/command/{commandUUID}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/command/{commandUUID}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        UUID commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            Success result = apiInstance.deleteACommand(commandUUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteACommand");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        UUID commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            Success result = apiInstance.deleteACommand(commandUUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteACommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
UUID *commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific command.
[apiInstance deleteACommandWith:commandUUID
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteACommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific command.
                Success result = apiInstance.deleteACommand(commandUUID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.deleteACommand: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific command.
    api_response = api_instance.delete_a_command(commandUUID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->deleteACommand: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = CommandsApi::Context::default();
    let result = client.deleteACommand(commandUUID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
commandUUID*
UUID (uuid)
Required

Responses

deleteCommands

Delete some commands


/commands

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/commands?serialNumber=serialNumber_example&startDate=789&endDate=789"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 

        try {
            Success result = apiInstance.deleteCommands(serialNumber, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteCommands");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 

        try {
            Success result = apiInstance.deleteCommands(serialNumber, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteCommands");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)

// Delete some commands
[apiInstance deleteCommandsWith:serialNumber
    startDate:startDate
    endDate:endDate
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789 // {Long} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteCommandsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)

            try {
                // Delete some commands
                Success result = apiInstance.deleteCommands(serialNumber, startDate, endDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.deleteCommands: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 

try {
    $result = $api_instance->deleteCommands($serialNumber, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->deleteCommands: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 

eval {
    my $result = $api_instance->deleteCommands(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->deleteCommands: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)

try:
    # Delete some commands
    api_response = api_instance.delete_commands(serialNumber, startDate=startDate, endDate=endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->deleteCommands: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long

    let mut context = CommandsApi::Context::default();
    let result = client.deleteCommands(serialNumber, startDate, endDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
serialNumber*
String
Required
startDate
Long (int64)
endDate
Long (int64)

Responses

deleteDeviceCapabilities

Delete the capabilities for a given device.


/device/{serialNumber}/capabilities

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/capabilities"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            Success result = apiInstance.deleteDeviceCapabilities(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceCapabilities");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            Success result = apiInstance.deleteDeviceCapabilities(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceCapabilities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Delete the capabilities for a given device.
[apiInstance deleteDeviceCapabilitiesWith:serialNumber
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDeviceCapabilitiesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Delete the capabilities for a given device.
                Success result = apiInstance.deleteDeviceCapabilities(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.deleteDeviceCapabilities: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Delete the capabilities for a given device.
    api_response = api_instance.delete_device_capabilities(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->deleteDeviceCapabilities: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = CommandsApi::Context::default();
    let result = client.deleteDeviceCapabilities(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

deleteDeviceHealthChecks

Delete some device health checks.


/device/{serialNumber}/healthchecks

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/healthchecks?startDate=789&endDate=789"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 

        try {
            Success result = apiInstance.deleteDeviceHealthChecks(serialNumber, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceHealthChecks");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 

        try {
            Success result = apiInstance.deleteDeviceHealthChecks(serialNumber, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceHealthChecks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)

// Delete some device health checks.
[apiInstance deleteDeviceHealthChecksWith:serialNumber
    startDate:startDate
    endDate:endDate
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789 // {Long} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDeviceHealthChecksExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)

            try {
                // Delete some device health checks.
                Success result = apiInstance.deleteDeviceHealthChecks(serialNumber, startDate, endDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.deleteDeviceHealthChecks: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 

try {
    $result = $api_instance->deleteDeviceHealthChecks($serialNumber, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->deleteDeviceHealthChecks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 

eval {
    my $result = $api_instance->deleteDeviceHealthChecks(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->deleteDeviceHealthChecks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)

try:
    # Delete some device health checks.
    api_response = api_instance.delete_device_health_checks(serialNumber, startDate=startDate, endDate=endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->deleteDeviceHealthChecks: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long

    let mut context = CommandsApi::Context::default();
    let result = client.deleteDeviceHealthChecks(serialNumber, startDate, endDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
startDate
Long (int64)
endDate
Long (int64)

Responses

deleteDeviceLogs

Delete some device logs.


/device/{serialNumber}/logs

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/logs?startDate=789&endDate=789&logType=789"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long logType = 789; // Long | 0=any kind of logs (default) 1=normal logs only 2=crash logs only

        try {
            Success result = apiInstance.deleteDeviceLogs(serialNumber, startDate, endDate, logType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceLogs");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long logType = 789; // Long | 0=any kind of logs (default) 1=normal logs only 2=crash logs only

        try {
            Success result = apiInstance.deleteDeviceLogs(serialNumber, startDate, endDate, logType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)
Long *logType = 789; // 0=any kind of logs (default) 1=normal logs only 2=crash logs only (optional) (default to null)

// Delete some device logs.
[apiInstance deleteDeviceLogsWith:serialNumber
    startDate:startDate
    endDate:endDate
    logType:logType
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789, // {Long} 
  'logType': 789 // {Long} 0=any kind of logs (default) 1=normal logs only 2=crash logs only
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDeviceLogsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)
            var logType = 789;  // Long | 0=any kind of logs (default) 1=normal logs only 2=crash logs only (optional)  (default to null)

            try {
                // Delete some device logs.
                Success result = apiInstance.deleteDeviceLogs(serialNumber, startDate, endDate, logType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.deleteDeviceLogs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 
$logType = 789; // Long | 0=any kind of logs (default) 1=normal logs only 2=crash logs only

try {
    $result = $api_instance->deleteDeviceLogs($serialNumber, $startDate, $endDate, $logType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->deleteDeviceLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 
my $logType = 789; # Long | 0=any kind of logs (default) 1=normal logs only 2=crash logs only

eval {
    my $result = $api_instance->deleteDeviceLogs(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate, logType => $logType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->deleteDeviceLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)
logType = 789 # Long | 0=any kind of logs (default) 1=normal logs only 2=crash logs only (optional) (default to null)

try:
    # Delete some device logs.
    api_response = api_instance.delete_device_logs(serialNumber, startDate=startDate, endDate=endDate, logType=logType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->deleteDeviceLogs: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long
    let logType = 789; // Long

    let mut context = CommandsApi::Context::default();
    let result = client.deleteDeviceLogs(serialNumber, startDate, endDate, logType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
startDate
Long (int64)
endDate
Long (int64)
logType
Long (int64)
0=any kind of logs (default) 1=normal logs only 2=crash logs only

Responses

deleteDeviceStats

Get the latest statistics for a given device.


/device/{serialNumber}/statistics

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/statistics?startDate=789&endDate=789"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 

        try {
            Success result = apiInstance.deleteDeviceStats(serialNumber, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceStats");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 

        try {
            Success result = apiInstance.deleteDeviceStats(serialNumber, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#deleteDeviceStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)

// Get the latest statistics for a given device.
[apiInstance deleteDeviceStatsWith:serialNumber
    startDate:startDate
    endDate:endDate
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789 // {Long} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDeviceStatsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)

            try {
                // Get the latest statistics for a given device.
                Success result = apiInstance.deleteDeviceStats(serialNumber, startDate, endDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.deleteDeviceStats: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 

try {
    $result = $api_instance->deleteDeviceStats($serialNumber, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->deleteDeviceStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 

eval {
    my $result = $api_instance->deleteDeviceStats(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->deleteDeviceStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)

try:
    # Get the latest statistics for a given device.
    api_response = api_instance.delete_device_stats(serialNumber, startDate=startDate, endDate=endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->deleteDeviceStats: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long

    let mut context = CommandsApi::Context::default();
    let result = client.deleteDeviceStats(serialNumber, startDate, endDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
startDate
Long (int64)
endDate
Long (int64)

Responses

eventQueueRequest

Request a list of queued events.


/device/{serialNumber}/eventqueue

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/eventqueue" \
 -d '{
  "types" : [ "dhcp", "dhcp" ],
  "serialNumber" : "serialNumber"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        EventQueueRequest eventQueueRequest = ; // EventQueueRequest | 

        try {
            apiInstance.eventQueueRequest(serialNumber, eventQueueRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#eventQueueRequest");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        EventQueueRequest eventQueueRequest = ; // EventQueueRequest | 

        try {
            apiInstance.eventQueueRequest(serialNumber, eventQueueRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#eventQueueRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
EventQueueRequest *eventQueueRequest = ; //  (optional)

// Request a list of queued events.
[apiInstance eventQueueRequestWith:serialNumber
    eventQueueRequest:eventQueueRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'eventQueueRequest':  // {EventQueueRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.eventQueueRequest(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventQueueRequestExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var eventQueueRequest = new EventQueueRequest(); // EventQueueRequest |  (optional) 

            try {
                // Request a list of queued events.
                apiInstance.eventQueueRequest(serialNumber, eventQueueRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.eventQueueRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$eventQueueRequest = ; // EventQueueRequest | 

try {
    $api_instance->eventQueueRequest($serialNumber, $eventQueueRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->eventQueueRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $eventQueueRequest = WWW::OPenAPIClient::Object::EventQueueRequest->new(); # EventQueueRequest | 

eval {
    $api_instance->eventQueueRequest(serialNumber => $serialNumber, eventQueueRequest => $eventQueueRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->eventQueueRequest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
eventQueueRequest =  # EventQueueRequest |  (optional)

try:
    # Request a list of queued events.
    api_instance.event_queue_request(serialNumber, eventQueueRequest=eventQueueRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->eventQueueRequest: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let eventQueueRequest = ; // EventQueueRequest

    let mut context = CommandsApi::Context::default();
    let result = client.eventQueueRequest(serialNumber, eventQueueRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
eventQueueRequest

Message request details

Responses

eventTelemetryStreamRequest

Request a telemetry stream.


/device/{serialNumber}/telemetry

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/telemetry?statusOnly=true" \
 -d '{
  "types" : [ "dhcp-snooping", "dhcp-snooping" ],
  "serialNumber" : "serialNumber",
  "kafka" : false,
  "lifetime" : 6,
  "interval" : 0,
  "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Boolean statusOnly = true; // Boolean | 
        TelemetryStreamRequest telemetryStreamRequest = ; // TelemetryStreamRequest | 

        try {
            apiInstance.eventTelemetryStreamRequest(serialNumber, statusOnly, telemetryStreamRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#eventTelemetryStreamRequest");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Boolean statusOnly = true; // Boolean | 
        TelemetryStreamRequest telemetryStreamRequest = ; // TelemetryStreamRequest | 

        try {
            apiInstance.eventTelemetryStreamRequest(serialNumber, statusOnly, telemetryStreamRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#eventTelemetryStreamRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Boolean *statusOnly = true; //  (optional) (default to false)
TelemetryStreamRequest *telemetryStreamRequest = ; //  (optional)

// Request a telemetry stream.
[apiInstance eventTelemetryStreamRequestWith:serialNumber
    statusOnly:statusOnly
    telemetryStreamRequest:telemetryStreamRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'statusOnly': true, // {Boolean} 
  'telemetryStreamRequest':  // {TelemetryStreamRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.eventTelemetryStreamRequest(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class eventTelemetryStreamRequestExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var statusOnly = true;  // Boolean |  (optional)  (default to false)
            var telemetryStreamRequest = new TelemetryStreamRequest(); // TelemetryStreamRequest |  (optional) 

            try {
                // Request a telemetry stream.
                apiInstance.eventTelemetryStreamRequest(serialNumber, statusOnly, telemetryStreamRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.eventTelemetryStreamRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$statusOnly = true; // Boolean | 
$telemetryStreamRequest = ; // TelemetryStreamRequest | 

try {
    $api_instance->eventTelemetryStreamRequest($serialNumber, $statusOnly, $telemetryStreamRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->eventTelemetryStreamRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $statusOnly = true; # Boolean | 
my $telemetryStreamRequest = WWW::OPenAPIClient::Object::TelemetryStreamRequest->new(); # TelemetryStreamRequest | 

eval {
    $api_instance->eventTelemetryStreamRequest(serialNumber => $serialNumber, statusOnly => $statusOnly, telemetryStreamRequest => $telemetryStreamRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->eventTelemetryStreamRequest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
statusOnly = true # Boolean |  (optional) (default to false)
telemetryStreamRequest =  # TelemetryStreamRequest |  (optional)

try:
    # Request a telemetry stream.
    api_instance.event_telemetry_stream_request(serialNumber, statusOnly=statusOnly, telemetryStreamRequest=telemetryStreamRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->eventTelemetryStreamRequest: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let statusOnly = true; // Boolean
    let telemetryStreamRequest = ; // TelemetryStreamRequest

    let mut context = CommandsApi::Context::default();
    let result = client.eventTelemetryStreamRequest(serialNumber, statusOnly, telemetryStreamRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
telemetryStreamRequest

Message request details
Query parameters
Name Description
statusOnly
Boolean

Responses

factoryReset

Factory reset a device.


/device/{serialNumber}/factory

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/factory" \
 -d '{
  "serialNumber" : "serialNumber",
  "when" : 0,
  "keepRedirector" : true
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        FactoryRequest factoryRequest = ; // FactoryRequest | 

        try {
            apiInstance.factoryReset(serialNumber, factoryRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#factoryReset");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        FactoryRequest factoryRequest = ; // FactoryRequest | 

        try {
            apiInstance.factoryReset(serialNumber, factoryRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#factoryReset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
FactoryRequest *factoryRequest = ; //  (optional)

// Factory reset a device.
[apiInstance factoryResetWith:serialNumber
    factoryRequest:factoryRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'factoryRequest':  // {FactoryRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.factoryReset(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class factoryResetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var factoryRequest = new FactoryRequest(); // FactoryRequest |  (optional) 

            try {
                // Factory reset a device.
                apiInstance.factoryReset(serialNumber, factoryRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.factoryReset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$factoryRequest = ; // FactoryRequest | 

try {
    $api_instance->factoryReset($serialNumber, $factoryRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->factoryReset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $factoryRequest = WWW::OPenAPIClient::Object::FactoryRequest->new(); # FactoryRequest | 

eval {
    $api_instance->factoryReset(serialNumber => $serialNumber, factoryRequest => $factoryRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->factoryReset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
factoryRequest =  # FactoryRequest |  (optional)

try:
    # Factory reset a device.
    api_instance.factory_reset(serialNumber, factoryRequest=factoryRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->factoryReset: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let factoryRequest = ; // FactoryRequest

    let mut context = CommandsApi::Context::default();
    let result = client.factoryReset(serialNumber, factoryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
factoryRequest

Command details

Responses

getACommandDetails

Returns a specific command.

Returns a specific command


/command/{commandUUID}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/command/{commandUUID}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        UUID commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            CommandInfo result = apiInstance.getACommandDetails(commandUUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getACommandDetails");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        UUID commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            CommandInfo result = apiInstance.getACommandDetails(commandUUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getACommandDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
UUID *commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Returns a specific command.
[apiInstance getACommandDetailsWith:commandUUID
              completionHandler: ^(CommandInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getACommandDetailsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Returns a specific command.
                CommandInfo result = apiInstance.getACommandDetails(commandUUID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getACommandDetails: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Returns a specific command.
    api_response = api_instance.get_a_command_details(commandUUID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getACommandDetails: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let commandUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = CommandsApi::Context::default();
    let result = client.getACommandDetails(commandUUID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
commandUUID*
UUID (uuid)
Required

Responses

getCommandList

Returns a list of commands.

Get a list of commands.


/commands

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/commands?serialNumber=serialNumber_example&startDate=789&endDate=789&offset=789&limit=789&newest=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

        try {
            CommandInfoList result = apiInstance.getCommandList(serialNumber, startDate, endDate, offset, limit, newest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getCommandList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

        try {
            CommandInfoList result = apiInstance.getCommandList(serialNumber, startDate, endDate, offset, limit, newest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getCommandList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (optional) (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)
Long *offset = 789; //  (optional) (default to null)
Long *limit = 789; //  (optional) (default to null)
Boolean *newest = true; // Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)

// Returns a list of commands.
[apiInstance getCommandListWith:serialNumber
    startDate:startDate
    endDate:endDate
    offset:offset
    limit:limit
    newest:newest
              completionHandler: ^(CommandInfoList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var opts = {
  'serialNumber': serialNumber_example, // {String} 
  'startDate': 789, // {Long} 
  'endDate': 789, // {Long} 
  'offset': 789, // {Long} 
  'limit': 789, // {Long} 
  'newest': true // {Boolean} Selecting this option means the newest record will be returned. Use limit to select how many.
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommandListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (optional)  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)
            var offset = 789;  // Long |  (optional)  (default to null)
            var limit = 789;  // Long |  (optional)  (default to null)
            var newest = true;  // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional)  (default to null)

            try {
                // Returns a list of commands.
                CommandInfoList result = apiInstance.getCommandList(serialNumber, startDate, endDate, offset, limit, newest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getCommandList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 
$offset = 789; // Long | 
$limit = 789; // Long | 
$newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

try {
    $result = $api_instance->getCommandList($serialNumber, $startDate, $endDate, $offset, $limit, $newest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->getCommandList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 
my $offset = 789; # Long | 
my $limit = 789; # Long | 
my $newest = true; # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

eval {
    my $result = $api_instance->getCommandList(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate, offset => $offset, limit => $limit, newest => $newest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->getCommandList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (optional) (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)
offset = 789 # Long |  (optional) (default to null)
limit = 789 # Long |  (optional) (default to null)
newest = true # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)

try:
    # Returns a list of commands.
    api_response = api_instance.get_command_list(serialNumber=serialNumber, startDate=startDate, endDate=endDate, offset=offset, limit=limit, newest=newest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getCommandList: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long
    let offset = 789; // Long
    let limit = 789; // Long
    let newest = true; // Boolean

    let mut context = CommandsApi::Context::default();
    let result = client.getCommandList(serialNumber, startDate, endDate, offset, limit, newest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
serialNumber
String
startDate
Long (int64)
endDate
Long (int64)
offset
Long (int64)
limit
Long (int64)
newest
Boolean
Selecting this option means the newest record will be returned. Use limit to select how many.

Responses

getDeviceCapabilities

Get the latest capabilities for a given device.


/device/{serialNumber}/capabilities

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/capabilities"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            DeviceCapabilities result = apiInstance.getDeviceCapabilities(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceCapabilities");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            DeviceCapabilities result = apiInstance.getDeviceCapabilities(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceCapabilities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Get the latest capabilities for a given device.
[apiInstance getDeviceCapabilitiesWith:serialNumber
              completionHandler: ^(DeviceCapabilities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceCapabilitiesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Get the latest capabilities for a given device.
                DeviceCapabilities result = apiInstance.getDeviceCapabilities(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getDeviceCapabilities: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Get the latest capabilities for a given device.
    api_response = api_instance.get_device_capabilities(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getDeviceCapabilities: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = CommandsApi::Context::default();
    let result = client.getDeviceCapabilities(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

getDeviceHealthChecks

Get the latest health checks for a given device.


/device/{serialNumber}/healthchecks

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/healthchecks?startDate=789&endDate=789&offset=789&limit=789&newest=true&lastOnly=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean lastOnly = true; // Boolean | Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.

        try {
            HealthCheckList result = apiInstance.getDeviceHealthChecks(serialNumber, startDate, endDate, offset, limit, newest, lastOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceHealthChecks");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean lastOnly = true; // Boolean | Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.

        try {
            HealthCheckList result = apiInstance.getDeviceHealthChecks(serialNumber, startDate, endDate, offset, limit, newest, lastOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceHealthChecks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)
Long *offset = 789; //  (optional) (default to null)
Long *limit = 789; //  (optional) (default to null)
Boolean *newest = true; // Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
Boolean *lastOnly = true; // Selecting this option means the last healthcheck will be returned. All other parameters will be ignored. (optional) (default to null)

// Get the latest health checks for a given device.
[apiInstance getDeviceHealthChecksWith:serialNumber
    startDate:startDate
    endDate:endDate
    offset:offset
    limit:limit
    newest:newest
    lastOnly:lastOnly
              completionHandler: ^(HealthCheckList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789, // {Long} 
  'offset': 789, // {Long} 
  'limit': 789, // {Long} 
  'newest': true, // {Boolean} Selecting this option means the newest record will be returned. Use limit to select how many.
  'lastOnly': true // {Boolean} Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceHealthChecksExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)
            var offset = 789;  // Long |  (optional)  (default to null)
            var limit = 789;  // Long |  (optional)  (default to null)
            var newest = true;  // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional)  (default to null)
            var lastOnly = true;  // Boolean | Selecting this option means the last healthcheck will be returned. All other parameters will be ignored. (optional)  (default to null)

            try {
                // Get the latest health checks for a given device.
                HealthCheckList result = apiInstance.getDeviceHealthChecks(serialNumber, startDate, endDate, offset, limit, newest, lastOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getDeviceHealthChecks: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 
$offset = 789; // Long | 
$limit = 789; // Long | 
$newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
$lastOnly = true; // Boolean | Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.

try {
    $result = $api_instance->getDeviceHealthChecks($serialNumber, $startDate, $endDate, $offset, $limit, $newest, $lastOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->getDeviceHealthChecks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 
my $offset = 789; # Long | 
my $limit = 789; # Long | 
my $newest = true; # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
my $lastOnly = true; # Boolean | Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.

eval {
    my $result = $api_instance->getDeviceHealthChecks(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate, offset => $offset, limit => $limit, newest => $newest, lastOnly => $lastOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->getDeviceHealthChecks: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)
offset = 789 # Long |  (optional) (default to null)
limit = 789 # Long |  (optional) (default to null)
newest = true # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
lastOnly = true # Boolean | Selecting this option means the last healthcheck will be returned. All other parameters will be ignored. (optional) (default to null)

try:
    # Get the latest health checks for a given device.
    api_response = api_instance.get_device_health_checks(serialNumber, startDate=startDate, endDate=endDate, offset=offset, limit=limit, newest=newest, lastOnly=lastOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getDeviceHealthChecks: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long
    let offset = 789; // Long
    let limit = 789; // Long
    let newest = true; // Boolean
    let lastOnly = true; // Boolean

    let mut context = CommandsApi::Context::default();
    let result = client.getDeviceHealthChecks(serialNumber, startDate, endDate, offset, limit, newest, lastOnly, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
startDate
Long (int64)
endDate
Long (int64)
offset
Long (int64)
limit
Long (int64)
newest
Boolean
Selecting this option means the newest record will be returned. Use limit to select how many.
lastOnly
Boolean
Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.

Responses

getDeviceLogs

Get the latest logs for a given device


/device/{serialNumber}/logs

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/logs?startDate=789&endDate=789&offset=789&limit=789&logType=789&newest=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Long logType = 789; // Long | 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

        try {
            DeviceLogList result = apiInstance.getDeviceLogs(serialNumber, startDate, endDate, offset, limit, logType, newest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceLogs");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Long logType = 789; // Long | 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

        try {
            DeviceLogList result = apiInstance.getDeviceLogs(serialNumber, startDate, endDate, offset, limit, logType, newest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)
Long *offset = 789; //  (optional) (default to null)
Long *limit = 789; //  (optional) (default to null)
Long *logType = 789; // 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only (optional) (default to null)
Boolean *newest = true; // Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)

// Get the latest logs for a given device
[apiInstance getDeviceLogsWith:serialNumber
    startDate:startDate
    endDate:endDate
    offset:offset
    limit:limit
    logType:logType
    newest:newest
              completionHandler: ^(DeviceLogList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789, // {Long} 
  'offset': 789, // {Long} 
  'limit': 789, // {Long} 
  'logType': 789, // {Long} 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only
  'newest': true // {Boolean} Selecting this option means the newest record will be returned. Use limit to select how many.
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceLogsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)
            var offset = 789;  // Long |  (optional)  (default to null)
            var limit = 789;  // Long |  (optional)  (default to null)
            var logType = 789;  // Long | 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only (optional)  (default to null)
            var newest = true;  // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional)  (default to null)

            try {
                // Get the latest logs for a given device
                DeviceLogList result = apiInstance.getDeviceLogs(serialNumber, startDate, endDate, offset, limit, logType, newest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getDeviceLogs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 
$offset = 789; // Long | 
$limit = 789; // Long | 
$logType = 789; // Long | 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only
$newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

try {
    $result = $api_instance->getDeviceLogs($serialNumber, $startDate, $endDate, $offset, $limit, $logType, $newest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->getDeviceLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 
my $offset = 789; # Long | 
my $limit = 789; # Long | 
my $logType = 789; # Long | 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only
my $newest = true; # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.

eval {
    my $result = $api_instance->getDeviceLogs(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate, offset => $offset, limit => $limit, logType => $logType, newest => $newest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->getDeviceLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)
offset = 789 # Long |  (optional) (default to null)
limit = 789 # Long |  (optional) (default to null)
logType = 789 # Long | 0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only (optional) (default to null)
newest = true # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)

try:
    # Get the latest logs for a given device
    api_response = api_instance.get_device_logs(serialNumber, startDate=startDate, endDate=endDate, offset=offset, limit=limit, logType=logType, newest=newest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getDeviceLogs: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long
    let offset = 789; // Long
    let limit = 789; // Long
    let logType = 789; // Long
    let newest = true; // Boolean

    let mut context = CommandsApi::Context::default();
    let result = client.getDeviceLogs(serialNumber, startDate, endDate, offset, limit, logType, newest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
startDate
Long (int64)
endDate
Long (int64)
offset
Long (int64)
limit
Long (int64)
logType
Long (int64)
0=any kind of logs (default) 0=normal logs, 1=crash logs, 2=reboot logs only
newest
Boolean
Selecting this option means the newest record will be returned. Use limit to select how many.

Responses

getDeviceStats

Get the latest statistics for a given device.


/device/{serialNumber}/statistics

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/statistics?startDate=789&endDate=789&offset=789&limit=789&lastOnly=true&newest=true&countOnly=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Boolean lastOnly = true; // Boolean | Selecting this option means the Last Statistics block
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean countOnly = true; // Boolean | Return the number of matching records.

        try {
            getDeviceStats_200_response result = apiInstance.getDeviceStats(serialNumber, startDate, endDate, offset, limit, lastOnly, newest, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceStats");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        Long startDate = 789; // Long | 
        Long endDate = 789; // Long | 
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        Boolean lastOnly = true; // Boolean | Selecting this option means the Last Statistics block
        Boolean newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean countOnly = true; // Boolean | Return the number of matching records.

        try {
            getDeviceStats_200_response result = apiInstance.getDeviceStats(serialNumber, startDate, endDate, offset, limit, lastOnly, newest, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Long *startDate = 789; //  (optional) (default to null)
Long *endDate = 789; //  (optional) (default to null)
Long *offset = 789; //  (optional) (default to null)
Long *limit = 789; //  (optional) (default to null)
Boolean *lastOnly = true; // Selecting this option means the Last Statistics block (optional) (default to null)
Boolean *newest = true; // Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
Boolean *countOnly = true; // Return the number of matching records. (optional) (default to null)

// Get the latest statistics for a given device.
[apiInstance getDeviceStatsWith:serialNumber
    startDate:startDate
    endDate:endDate
    offset:offset
    limit:limit
    lastOnly:lastOnly
    newest:newest
    countOnly:countOnly
              completionHandler: ^(getDeviceStats_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'startDate': 789, // {Long} 
  'endDate': 789, // {Long} 
  'offset': 789, // {Long} 
  'limit': 789, // {Long} 
  'lastOnly': true, // {Boolean} Selecting this option means the Last Statistics block
  'newest': true, // {Boolean} Selecting this option means the newest record will be returned. Use limit to select how many.
  'countOnly': true // {Boolean} Return the number of matching records.
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceStatsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var startDate = 789;  // Long |  (optional)  (default to null)
            var endDate = 789;  // Long |  (optional)  (default to null)
            var offset = 789;  // Long |  (optional)  (default to null)
            var limit = 789;  // Long |  (optional)  (default to null)
            var lastOnly = true;  // Boolean | Selecting this option means the Last Statistics block (optional)  (default to null)
            var newest = true;  // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional)  (default to null)
            var countOnly = true;  // Boolean | Return the number of matching records. (optional)  (default to null)

            try {
                // Get the latest statistics for a given device.
                getDeviceStats_200_response result = apiInstance.getDeviceStats(serialNumber, startDate, endDate, offset, limit, lastOnly, newest, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getDeviceStats: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$startDate = 789; // Long | 
$endDate = 789; // Long | 
$offset = 789; // Long | 
$limit = 789; // Long | 
$lastOnly = true; // Boolean | Selecting this option means the Last Statistics block
$newest = true; // Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
$countOnly = true; // Boolean | Return the number of matching records.

try {
    $result = $api_instance->getDeviceStats($serialNumber, $startDate, $endDate, $offset, $limit, $lastOnly, $newest, $countOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->getDeviceStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $startDate = 789; # Long | 
my $endDate = 789; # Long | 
my $offset = 789; # Long | 
my $limit = 789; # Long | 
my $lastOnly = true; # Boolean | Selecting this option means the Last Statistics block
my $newest = true; # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many.
my $countOnly = true; # Boolean | Return the number of matching records.

eval {
    my $result = $api_instance->getDeviceStats(serialNumber => $serialNumber, startDate => $startDate, endDate => $endDate, offset => $offset, limit => $limit, lastOnly => $lastOnly, newest => $newest, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommandsApi->getDeviceStats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
startDate = 789 # Long |  (optional) (default to null)
endDate = 789 # Long |  (optional) (default to null)
offset = 789 # Long |  (optional) (default to null)
limit = 789 # Long |  (optional) (default to null)
lastOnly = true # Boolean | Selecting this option means the Last Statistics block (optional) (default to null)
newest = true # Boolean | Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
countOnly = true # Boolean | Return the number of matching records. (optional) (default to null)

try:
    # Get the latest statistics for a given device.
    api_response = api_instance.get_device_stats(serialNumber, startDate=startDate, endDate=endDate, offset=offset, limit=limit, lastOnly=lastOnly, newest=newest, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getDeviceStats: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let startDate = 789; // Long
    let endDate = 789; // Long
    let offset = 789; // Long
    let limit = 789; // Long
    let lastOnly = true; // Boolean
    let newest = true; // Boolean
    let countOnly = true; // Boolean

    let mut context = CommandsApi::Context::default();
    let result = client.getDeviceStats(serialNumber, startDate, endDate, offset, limit, lastOnly, newest, countOnly, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
startDate
Long (int64)
endDate
Long (int64)
offset
Long (int64)
limit
Long (int64)
lastOnly
Boolean
Selecting this option means the Last Statistics block
newest
Boolean
Selecting this option means the newest record will be returned. Use limit to select how many.
countOnly
Boolean
Return the number of matching records.

Responses

getDeviceStatus

Get the latest status for a given device.


/device/{serialNumber}/status

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/status"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            DeviceStatus result = apiInstance.getDeviceStatus(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceStatus");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            DeviceStatus result = apiInstance.getDeviceStatus(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getDeviceStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Get the latest status for a given device.
[apiInstance getDeviceStatusWith:serialNumber
              completionHandler: ^(DeviceStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceStatusExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Get the latest status for a given device.
                DeviceStatus result = apiInstance.getDeviceStatus(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getDeviceStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Get the latest status for a given device.
    api_response = api_instance.get_device_status(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getDeviceStatus: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = CommandsApi::Context::default();
    let result = client.getDeviceStatus(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

getRttySessionInfo

Get the rtty parameters to initiate a session.


/device/{serialNumber}/rtty

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/rtty"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            RttySessionDetails result = apiInstance.getRttySessionInfo(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getRttySessionInfo");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            RttySessionDetails result = apiInstance.getRttySessionInfo(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#getRttySessionInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Get the rtty parameters to initiate a session.
[apiInstance getRttySessionInfoWith:serialNumber
              completionHandler: ^(RttySessionDetails output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRttySessionInfoExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Get the rtty parameters to initiate a session.
                RttySessionDetails result = apiInstance.getRttySessionInfo(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.getRttySessionInfo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Get the rtty parameters to initiate a session.
    api_response = api_instance.get_rtty_session_info(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandsApi->getRttySessionInfo: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = CommandsApi::Context::default();
    let result = client.getRttySessionInfo(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

ledsRequest

Blink the LEDs on a device.


/device/{serialNumber}/leds

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/leds" \
 -d '{
  "duration" : 6,
  "serialNumber" : "serialNumber",
  "pattern" : "true",
  "when" : 0
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        LEDsRequest lEDsRequest = ; // LEDsRequest | 

        try {
            apiInstance.ledsRequest(serialNumber, lEDsRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#ledsRequest");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        LEDsRequest lEDsRequest = ; // LEDsRequest | 

        try {
            apiInstance.ledsRequest(serialNumber, lEDsRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#ledsRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
LEDsRequest *lEDsRequest = ; //  (optional)

// Blink the LEDs on a device.
[apiInstance ledsRequestWith:serialNumber
    lEDsRequest:lEDsRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'lEDsRequest':  // {LEDsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.ledsRequest(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class ledsRequestExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var lEDsRequest = new LEDsRequest(); // LEDsRequest |  (optional) 

            try {
                // Blink the LEDs on a device.
                apiInstance.ledsRequest(serialNumber, lEDsRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.ledsRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$lEDsRequest = ; // LEDsRequest | 

try {
    $api_instance->ledsRequest($serialNumber, $lEDsRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->ledsRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $lEDsRequest = WWW::OPenAPIClient::Object::LEDsRequest->new(); # LEDsRequest | 

eval {
    $api_instance->ledsRequest(serialNumber => $serialNumber, lEDsRequest => $lEDsRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->ledsRequest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
lEDsRequest =  # LEDsRequest |  (optional)

try:
    # Blink the LEDs on a device.
    api_instance.leds_request(serialNumber, lEDsRequest=lEDsRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->ledsRequest: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let lEDsRequest = ; // LEDsRequest

    let mut context = CommandsApi::Context::default();
    let result = client.ledsRequest(serialNumber, lEDsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
lEDsRequest

Command details

Responses

messageRequest

Request a specific message


/device/{serialNumber}/request

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/request" \
 -d '{
  "serialNumber" : "serialNumber",
  "message" : "state",
  "when" : 0
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        MessageRequest messageRequest = ; // MessageRequest | 

        try {
            apiInstance.messageRequest(serialNumber, messageRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#messageRequest");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        MessageRequest messageRequest = ; // MessageRequest | 

        try {
            apiInstance.messageRequest(serialNumber, messageRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#messageRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
MessageRequest *messageRequest = ; //  (optional)

// Request a specific message
[apiInstance messageRequestWith:serialNumber
    messageRequest:messageRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'messageRequest':  // {MessageRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.messageRequest(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class messageRequestExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var messageRequest = new MessageRequest(); // MessageRequest |  (optional) 

            try {
                // Request a specific message
                apiInstance.messageRequest(serialNumber, messageRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.messageRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$messageRequest = ; // MessageRequest | 

try {
    $api_instance->messageRequest($serialNumber, $messageRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->messageRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $messageRequest = WWW::OPenAPIClient::Object::MessageRequest->new(); # MessageRequest | 

eval {
    $api_instance->messageRequest(serialNumber => $serialNumber, messageRequest => $messageRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->messageRequest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
messageRequest =  # MessageRequest |  (optional)

try:
    # Request a specific message
    api_instance.message_request(serialNumber, messageRequest=messageRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->messageRequest: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let messageRequest = ; // MessageRequest

    let mut context = CommandsApi::Context::default();
    let result = client.messageRequest(serialNumber, messageRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
messageRequest

Message request details

Responses

performPowerCycle

Perform PoE power cycle for some PoE ports.


/device/{serialNumber}/powercycle

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/powercycle" \
 -d '{
  "serial" : "serial",
  "ports" : [ {
    "name" : "[\"Ethernet0\"]",
    "cycle" : 36165
  }, {
    "name" : "[\"Ethernet0\"]",
    "cycle" : 36165
  } ],
  "when" : 0
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        array[PowerCycleRequest] powerCycleRequest = ; // array[PowerCycleRequest] | 

        try {
            apiInstance.performPowerCycle(serialNumber, powerCycleRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#performPowerCycle");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        array[PowerCycleRequest] powerCycleRequest = ; // array[PowerCycleRequest] | 

        try {
            apiInstance.performPowerCycle(serialNumber, powerCycleRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#performPowerCycle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
array[PowerCycleRequest] *powerCycleRequest = ; //  (optional)

// Perform PoE power cycle for some PoE ports.
[apiInstance performPowerCycleWith:serialNumber
    powerCycleRequest:powerCycleRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'powerCycleRequest':  // {array[PowerCycleRequest]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.performPowerCycle(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class performPowerCycleExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var powerCycleRequest = new array[PowerCycleRequest](); // array[PowerCycleRequest] |  (optional) 

            try {
                // Perform PoE power cycle for some PoE ports.
                apiInstance.performPowerCycle(serialNumber, powerCycleRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.performPowerCycle: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$powerCycleRequest = ; // array[PowerCycleRequest] | 

try {
    $api_instance->performPowerCycle($serialNumber, $powerCycleRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->performPowerCycle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $powerCycleRequest = [WWW::OPenAPIClient::Object::array[PowerCycleRequest]->new()]; # array[PowerCycleRequest] | 

eval {
    $api_instance->performPowerCycle(serialNumber => $serialNumber, powerCycleRequest => $powerCycleRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->performPowerCycle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
powerCycleRequest =  # array[PowerCycleRequest] |  (optional)

try:
    # Perform PoE power cycle for some PoE ports.
    api_instance.perform_power_cycle(serialNumber, powerCycleRequest=powerCycleRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->performPowerCycle: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let powerCycleRequest = ; // array[PowerCycleRequest]

    let mut context = CommandsApi::Context::default();
    let result = client.performPowerCycle(serialNumber, powerCycleRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
powerCycleRequest

Certificate update details

Responses

rebootDevice

Reboot a device.


/device/{serialNumber}/reboot

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/reboot" \
 -d '{
  "serialNumber" : "serialNumber",
  "when" : 0
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        RebootRequest rebootRequest = ; // RebootRequest | 

        try {
            apiInstance.rebootDevice(serialNumber, rebootRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#rebootDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        RebootRequest rebootRequest = ; // RebootRequest | 

        try {
            apiInstance.rebootDevice(serialNumber, rebootRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#rebootDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
RebootRequest *rebootRequest = ; //  (optional)

// Reboot a device.
[apiInstance rebootDeviceWith:serialNumber
    rebootRequest:rebootRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'rebootRequest':  // {RebootRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.rebootDevice(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class rebootDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var rebootRequest = new RebootRequest(); // RebootRequest |  (optional) 

            try {
                // Reboot a device.
                apiInstance.rebootDevice(serialNumber, rebootRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.rebootDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$rebootRequest = ; // RebootRequest | 

try {
    $api_instance->rebootDevice($serialNumber, $rebootRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->rebootDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $rebootRequest = WWW::OPenAPIClient::Object::RebootRequest->new(); # RebootRequest | 

eval {
    $api_instance->rebootDevice(serialNumber => $serialNumber, rebootRequest => $rebootRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->rebootDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
rebootRequest =  # RebootRequest |  (optional)

try:
    # Reboot a device.
    api_instance.reboot_device(serialNumber, rebootRequest=rebootRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->rebootDevice: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let rebootRequest = ; // RebootRequest

    let mut context = CommandsApi::Context::default();
    let result = client.rebootDevice(serialNumber, rebootRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
rebootRequest

Command details

Responses

sendRRMcommandsForADevice

Send RRM commands to a device.


/device/{serialNumber}/rrm

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/rrm" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        RRMActions rRMActions = ; // RRMActions | 

        try {
            apiInstance.sendRRMcommandsForADevice(serialNumber, rRMActions);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#sendRRMcommandsForADevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        RRMActions rRMActions = ; // RRMActions | 

        try {
            apiInstance.sendRRMcommandsForADevice(serialNumber, rRMActions);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#sendRRMcommandsForADevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
RRMActions *rRMActions = ; //  (optional)

// Send RRM commands to a device.
[apiInstance sendRRMcommandsForADeviceWith:serialNumber
    rRMActions:rRMActions
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'rRMActions':  // {RRMActions} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendRRMcommandsForADevice(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sendRRMcommandsForADeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var rRMActions = new RRMActions(); // RRMActions |  (optional) 

            try {
                // Send RRM commands to a device.
                apiInstance.sendRRMcommandsForADevice(serialNumber, rRMActions);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.sendRRMcommandsForADevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$rRMActions = ; // RRMActions | 

try {
    $api_instance->sendRRMcommandsForADevice($serialNumber, $rRMActions);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->sendRRMcommandsForADevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $rRMActions = WWW::OPenAPIClient::Object::RRMActions->new(); # RRMActions | 

eval {
    $api_instance->sendRRMcommandsForADevice(serialNumber => $serialNumber, rRMActions => $rRMActions);
};
if ($@) {
    warn "Exception when calling CommandsApi->sendRRMcommandsForADevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
rRMActions =  # RRMActions |  (optional)

try:
    # Send RRM commands to a device.
    api_instance.send_rr_mcommands_for_a_device(serialNumber, rRMActions=rRMActions)
except ApiException as e:
    print("Exception when calling CommandsApi->sendRRMcommandsForADevice: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let rRMActions = ; // RRMActions

    let mut context = CommandsApi::Context::default();
    let result = client.sendRRMcommandsForADevice(serialNumber, rRMActions, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
rRMActions

Commands to send

Responses

traceRequest

Launch a trace for a device.


/device/{serialNumber}/trace

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/trace" \
 -d '{
  "duration" : 6,
  "serialNumber" : "serialNumber",
  "numberOfPackets" : 1,
  "interface" : "interface",
  "when" : 0,
  "network" : "network"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        TraceRequest traceRequest = ; // TraceRequest | 

        try {
            apiInstance.traceRequest(serialNumber, traceRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#traceRequest");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        TraceRequest traceRequest = ; // TraceRequest | 

        try {
            apiInstance.traceRequest(serialNumber, traceRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#traceRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
TraceRequest *traceRequest = ; //  (optional)

// Launch a trace for a device.
[apiInstance traceRequestWith:serialNumber
    traceRequest:traceRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'traceRequest':  // {TraceRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.traceRequest(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class traceRequestExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var traceRequest = new TraceRequest(); // TraceRequest |  (optional) 

            try {
                // Launch a trace for a device.
                apiInstance.traceRequest(serialNumber, traceRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.traceRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$traceRequest = ; // TraceRequest | 

try {
    $api_instance->traceRequest($serialNumber, $traceRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->traceRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $traceRequest = WWW::OPenAPIClient::Object::TraceRequest->new(); # TraceRequest | 

eval {
    $api_instance->traceRequest(serialNumber => $serialNumber, traceRequest => $traceRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->traceRequest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
traceRequest =  # TraceRequest |  (optional)

try:
    # Launch a trace for a device.
    api_instance.trace_request(serialNumber, traceRequest=traceRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->traceRequest: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let traceRequest = ; // TraceRequest

    let mut context = CommandsApi::Context::default();
    let result = client.traceRequest(serialNumber, traceRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
traceRequest

Command details

Responses

transferDevice

Transfer a device to a new redirector.


/device/{serialNumber}/transfer

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/transfer" \
 -d '{
  "server" : "server",
  "serialNumber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "port" : 0
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        array[DeviceTransferRequest] deviceTransferRequest = ; // array[DeviceTransferRequest] | 

        try {
            apiInstance.transferDevice(serialNumber, deviceTransferRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#transferDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        array[DeviceTransferRequest] deviceTransferRequest = ; // array[DeviceTransferRequest] | 

        try {
            apiInstance.transferDevice(serialNumber, deviceTransferRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#transferDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
array[DeviceTransferRequest] *deviceTransferRequest = ; //  (optional)

// Transfer a device to a new redirector.
[apiInstance transferDeviceWith:serialNumber
    deviceTransferRequest:deviceTransferRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'deviceTransferRequest':  // {array[DeviceTransferRequest]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.transferDevice(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class transferDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var deviceTransferRequest = new array[DeviceTransferRequest](); // array[DeviceTransferRequest] |  (optional) 

            try {
                // Transfer a device to a new redirector.
                apiInstance.transferDevice(serialNumber, deviceTransferRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.transferDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$deviceTransferRequest = ; // array[DeviceTransferRequest] | 

try {
    $api_instance->transferDevice($serialNumber, $deviceTransferRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->transferDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $deviceTransferRequest = [WWW::OPenAPIClient::Object::array[DeviceTransferRequest]->new()]; # array[DeviceTransferRequest] | 

eval {
    $api_instance->transferDevice(serialNumber => $serialNumber, deviceTransferRequest => $deviceTransferRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->transferDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
deviceTransferRequest =  # array[DeviceTransferRequest] |  (optional)

try:
    # Transfer a device to a new redirector.
    api_instance.transfer_device(serialNumber, deviceTransferRequest=deviceTransferRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->transferDevice: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let deviceTransferRequest = ; // array[DeviceTransferRequest]

    let mut context = CommandsApi::Context::default();
    let result = client.transferDevice(serialNumber, deviceTransferRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
deviceTransferRequest

Transfer details

Responses

updateCertificates

Update the certificates for a device.


/device/{serialNumber}/certupdate

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/certupdate" \
 -d '{
  "encodedCertificate" : "encodedCertificate",
  "serialNumber" : "serialNumber"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        array[DeviceCertificateUpdateRequest] deviceCertificateUpdateRequest = ; // array[DeviceCertificateUpdateRequest] | 

        try {
            apiInstance.updateCertificates(serialNumber, deviceCertificateUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#updateCertificates");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        array[DeviceCertificateUpdateRequest] deviceCertificateUpdateRequest = ; // array[DeviceCertificateUpdateRequest] | 

        try {
            apiInstance.updateCertificates(serialNumber, deviceCertificateUpdateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#updateCertificates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
array[DeviceCertificateUpdateRequest] *deviceCertificateUpdateRequest = ; //  (optional)

// Update the certificates for a device.
[apiInstance updateCertificatesWith:serialNumber
    deviceCertificateUpdateRequest:deviceCertificateUpdateRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'deviceCertificateUpdateRequest':  // {array[DeviceCertificateUpdateRequest]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCertificates(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateCertificatesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var deviceCertificateUpdateRequest = new array[DeviceCertificateUpdateRequest](); // array[DeviceCertificateUpdateRequest] |  (optional) 

            try {
                // Update the certificates for a device.
                apiInstance.updateCertificates(serialNumber, deviceCertificateUpdateRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.updateCertificates: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$deviceCertificateUpdateRequest = ; // array[DeviceCertificateUpdateRequest] | 

try {
    $api_instance->updateCertificates($serialNumber, $deviceCertificateUpdateRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->updateCertificates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $deviceCertificateUpdateRequest = [WWW::OPenAPIClient::Object::array[DeviceCertificateUpdateRequest]->new()]; # array[DeviceCertificateUpdateRequest] | 

eval {
    $api_instance->updateCertificates(serialNumber => $serialNumber, deviceCertificateUpdateRequest => $deviceCertificateUpdateRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->updateCertificates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
deviceCertificateUpdateRequest =  # array[DeviceCertificateUpdateRequest] |  (optional)

try:
    # Update the certificates for a device.
    api_instance.update_certificates(serialNumber, deviceCertificateUpdateRequest=deviceCertificateUpdateRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->updateCertificates: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let deviceCertificateUpdateRequest = ; // array[DeviceCertificateUpdateRequest]

    let mut context = CommandsApi::Context::default();
    let result = client.updateCertificates(serialNumber, deviceCertificateUpdateRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
deviceCertificateUpdateRequest

Certificate update details

Responses

updateConfigurationForADevice

Configure a device.


/device/{serialNumber}/configure

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/configure" \
 -d '{
  "serialNumber" : "serialNumber",
  "configuration" : "configuration",
  "UUID" : 0,
  "when" : 6
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        DeviceConfigureRequest deviceConfigureRequest = ; // DeviceConfigureRequest | 

        try {
            apiInstance.updateConfigurationForADevice(serialNumber, deviceConfigureRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#updateConfigurationForADevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        DeviceConfigureRequest deviceConfigureRequest = ; // DeviceConfigureRequest | 

        try {
            apiInstance.updateConfigurationForADevice(serialNumber, deviceConfigureRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#updateConfigurationForADevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
DeviceConfigureRequest *deviceConfigureRequest = ; //  (optional)

// Configure a device.
[apiInstance updateConfigurationForADeviceWith:serialNumber
    deviceConfigureRequest:deviceConfigureRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'deviceConfigureRequest':  // {DeviceConfigureRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateConfigurationForADevice(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateConfigurationForADeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var deviceConfigureRequest = new DeviceConfigureRequest(); // DeviceConfigureRequest |  (optional) 

            try {
                // Configure a device.
                apiInstance.updateConfigurationForADevice(serialNumber, deviceConfigureRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.updateConfigurationForADevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$deviceConfigureRequest = ; // DeviceConfigureRequest | 

try {
    $api_instance->updateConfigurationForADevice($serialNumber, $deviceConfigureRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->updateConfigurationForADevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $deviceConfigureRequest = WWW::OPenAPIClient::Object::DeviceConfigureRequest->new(); # DeviceConfigureRequest | 

eval {
    $api_instance->updateConfigurationForADevice(serialNumber => $serialNumber, deviceConfigureRequest => $deviceConfigureRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->updateConfigurationForADevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
deviceConfigureRequest =  # DeviceConfigureRequest |  (optional)

try:
    # Configure a device.
    api_instance.update_configuration_for_a_device(serialNumber, deviceConfigureRequest=deviceConfigureRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->updateConfigurationForADevice: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let deviceConfigureRequest = ; // DeviceConfigureRequest

    let mut context = CommandsApi::Context::default();
    let result = client.updateConfigurationForADevice(serialNumber, deviceConfigureRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
deviceConfigureRequest

Command details

Responses

upgradeDeviceFirmware

Upgrade a device.


/device/{serialNumber}/upgrade

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/upgrade?FWsignature=fWsignature_example" \
 -d '{
  "serialNumber" : "serialNumber",
  "uri" : "uri",
  "when" : 0,
  "keepRedirector" : true
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        String fWsignature = fWsignature_example; // String | 
        UpgradeRequest upgradeRequest = ; // UpgradeRequest | 

        try {
            apiInstance.upgradeDeviceFirmware(serialNumber, fWsignature, upgradeRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#upgradeDeviceFirmware");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        String fWsignature = fWsignature_example; // String | 
        UpgradeRequest upgradeRequest = ; // UpgradeRequest | 

        try {
            apiInstance.upgradeDeviceFirmware(serialNumber, fWsignature, upgradeRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#upgradeDeviceFirmware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
String *fWsignature = fWsignature_example; //  (optional) (default to null)
UpgradeRequest *upgradeRequest = ; //  (optional)

// Upgrade a device.
[apiInstance upgradeDeviceFirmwareWith:serialNumber
    fWsignature:fWsignature
    upgradeRequest:upgradeRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'fWsignature': fWsignature_example, // {String} 
  'upgradeRequest':  // {UpgradeRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.upgradeDeviceFirmware(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class upgradeDeviceFirmwareExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var fWsignature = fWsignature_example;  // String |  (optional)  (default to null)
            var upgradeRequest = new UpgradeRequest(); // UpgradeRequest |  (optional) 

            try {
                // Upgrade a device.
                apiInstance.upgradeDeviceFirmware(serialNumber, fWsignature, upgradeRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.upgradeDeviceFirmware: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$fWsignature = fWsignature_example; // String | 
$upgradeRequest = ; // UpgradeRequest | 

try {
    $api_instance->upgradeDeviceFirmware($serialNumber, $fWsignature, $upgradeRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->upgradeDeviceFirmware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $fWsignature = fWsignature_example; # String | 
my $upgradeRequest = WWW::OPenAPIClient::Object::UpgradeRequest->new(); # UpgradeRequest | 

eval {
    $api_instance->upgradeDeviceFirmware(serialNumber => $serialNumber, fWsignature => $fWsignature, upgradeRequest => $upgradeRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->upgradeDeviceFirmware: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
fWsignature = fWsignature_example # String |  (optional) (default to null)
upgradeRequest =  # UpgradeRequest |  (optional)

try:
    # Upgrade a device.
    api_instance.upgrade_device_firmware(serialNumber, fWsignature=fWsignature, upgradeRequest=upgradeRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->upgradeDeviceFirmware: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let fWsignature = fWsignature_example; // String
    let upgradeRequest = ; // UpgradeRequest

    let mut context = CommandsApi::Context::default();
    let result = client.upgradeDeviceFirmware(serialNumber, fWsignature, upgradeRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
upgradeRequest

Command details
Query parameters
Name Description
FWsignature
String

Responses

wifiscanRequest

Launch a wifi scan for a device.


/device/{serialNumber}/wifiscan

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}/wifiscan" \
 -d '{
  "activeScan" : true,
  "serialNumber" : "serialNumber",
  "ies" : [ 20, 20 ],
  "verbose" : true
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommandsApi;

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

public class CommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        WifiScanRequest wifiScanRequest = ; // WifiScanRequest | 

        try {
            apiInstance.wifiscanRequest(serialNumber, wifiScanRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#wifiscanRequest");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CommandsApi;

public class CommandsApiExample {
    public static void main(String[] args) {
        CommandsApi apiInstance = new CommandsApi();
        String serialNumber = serialNumber_example; // String | 
        WifiScanRequest wifiScanRequest = ; // WifiScanRequest | 

        try {
            apiInstance.wifiscanRequest(serialNumber, wifiScanRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommandsApi#wifiscanRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
CommandsApi *apiInstance = [[CommandsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
WifiScanRequest *wifiScanRequest = ; //  (optional)

// Launch a wifi scan for a device.
[apiInstance wifiscanRequestWith:serialNumber
    wifiScanRequest:wifiScanRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.CommandsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'wifiScanRequest':  // {WifiScanRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.wifiscanRequest(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class wifiscanRequestExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CommandsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var wifiScanRequest = new WifiScanRequest(); // WifiScanRequest |  (optional) 

            try {
                // Launch a wifi scan for a device.
                apiInstance.wifiscanRequest(serialNumber, wifiScanRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommandsApi.wifiscanRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommandsApi();
$serialNumber = serialNumber_example; // String | 
$wifiScanRequest = ; // WifiScanRequest | 

try {
    $api_instance->wifiscanRequest($serialNumber, $wifiScanRequest);
} catch (Exception $e) {
    echo 'Exception when calling CommandsApi->wifiscanRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommandsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $wifiScanRequest = WWW::OPenAPIClient::Object::WifiScanRequest->new(); # WifiScanRequest | 

eval {
    $api_instance->wifiscanRequest(serialNumber => $serialNumber, wifiScanRequest => $wifiScanRequest);
};
if ($@) {
    warn "Exception when calling CommandsApi->wifiscanRequest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CommandsApi()
serialNumber = serialNumber_example # String |  (default to null)
wifiScanRequest =  # WifiScanRequest |  (optional)

try:
    # Launch a wifi scan for a device.
    api_instance.wifiscan_request(serialNumber, wifiScanRequest=wifiScanRequest)
except ApiException as e:
    print("Exception when calling CommandsApi->wifiscanRequest: %s\n" % e)
extern crate CommandsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let wifiScanRequest = ; // WifiScanRequest

    let mut context = CommandsApi::Context::default();
    let result = client.wifiscanRequest(serialNumber, wifiScanRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
wifiScanRequest

Scan details

Responses

Configurations

createDefaultConfiguration

Create a default configuration.

Create a default configuration.


/default_configuration/{name}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/default_configuration/{name}" \
 -d '{
  "configuration" : "configuration",
  "modelIds" : [ "modelIds", "modelIds" ],
  "created" : 0,
  "name" : "name",
  "description" : "description",
  "lastModified" : 6,
  "platform" : "ap"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 
        DefaultConfiguration defaultConfiguration = ; // DefaultConfiguration | 

        try {
            apiInstance.createDefaultConfiguration(name, defaultConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#createDefaultConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 
        DefaultConfiguration defaultConfiguration = ; // DefaultConfiguration | 

        try {
            apiInstance.createDefaultConfiguration(name, defaultConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#createDefaultConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
String *name = name_example; //  (default to null)
DefaultConfiguration *defaultConfiguration = ; //  (optional)

// Create a default configuration.
[apiInstance createDefaultConfigurationWith:name
    defaultConfiguration:defaultConfiguration
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ConfigurationsApi()
var name = name_example; // {String} 
var opts = {
  'defaultConfiguration':  // {DefaultConfiguration} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createDefaultConfiguration(name, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createDefaultConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationsApi();
            var name = name_example;  // String |  (default to null)
            var defaultConfiguration = new DefaultConfiguration(); // DefaultConfiguration |  (optional) 

            try {
                // Create a default configuration.
                apiInstance.createDefaultConfiguration(name, defaultConfiguration);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.createDefaultConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationsApi();
$name = name_example; // String | 
$defaultConfiguration = ; // DefaultConfiguration | 

try {
    $api_instance->createDefaultConfiguration($name, $defaultConfiguration);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationsApi->createDefaultConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationsApi->new();
my $name = name_example; # String | 
my $defaultConfiguration = WWW::OPenAPIClient::Object::DefaultConfiguration->new(); # DefaultConfiguration | 

eval {
    $api_instance->createDefaultConfiguration(name => $name, defaultConfiguration => $defaultConfiguration);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->createDefaultConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationsApi()
name = name_example # String |  (default to null)
defaultConfiguration =  # DefaultConfiguration |  (optional)

try:
    # Create a default configuration.
    api_instance.create_default_configuration(name, defaultConfiguration=defaultConfiguration)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->createDefaultConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let name = name_example; // String
    let defaultConfiguration = ; // DefaultConfiguration

    let mut context = ConfigurationsApi::Context::default();
    let result = client.createDefaultConfiguration(name, defaultConfiguration, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
Required
Body parameters
Name Description
defaultConfiguration

Information used to create the new device

Responses

deleteDefaultConfiguration

Delete a default default configuration

Delete a default default configuration


/default_configuration/{name}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/default_configuration/{name}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 

        try {
            apiInstance.deleteDefaultConfiguration(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#deleteDefaultConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 

        try {
            apiInstance.deleteDefaultConfiguration(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#deleteDefaultConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
String *name = name_example; //  (default to null)

// Delete a default default configuration
[apiInstance deleteDefaultConfigurationWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ConfigurationsApi()
var name = name_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDefaultConfiguration(name, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDefaultConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationsApi();
            var name = name_example;  // String |  (default to null)

            try {
                // Delete a default default configuration
                apiInstance.deleteDefaultConfiguration(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.deleteDefaultConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationsApi();
$name = name_example; // String | 

try {
    $api_instance->deleteDefaultConfiguration($name);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationsApi->deleteDefaultConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationsApi->new();
my $name = name_example; # String | 

eval {
    $api_instance->deleteDefaultConfiguration(name => $name);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->deleteDefaultConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationsApi()
name = name_example # String |  (default to null)

try:
    # Delete a default default configuration
    api_instance.delete_default_configuration(name)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->deleteDefaultConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let name = name_example; // String

    let mut context = ConfigurationsApi::Context::default();
    let result = client.deleteDefaultConfiguration(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
Required

Responses

getDefaultConfiguration

Retrieve a default configuration.

Retrieve a default configuration.


/default_configuration/{name}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/default_configuration/{name}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 

        try {
            DefaultConfiguration result = apiInstance.getDefaultConfiguration(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getDefaultConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 

        try {
            DefaultConfiguration result = apiInstance.getDefaultConfiguration(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getDefaultConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
String *name = name_example; //  (default to null)

// Retrieve a default configuration.
[apiInstance getDefaultConfigurationWith:name
              completionHandler: ^(DefaultConfiguration output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ConfigurationsApi()
var name = name_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDefaultConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationsApi();
            var name = name_example;  // String |  (default to null)

            try {
                // Retrieve a default configuration.
                DefaultConfiguration result = apiInstance.getDefaultConfiguration(name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.getDefaultConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationsApi();
$name = name_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationsApi->new();
my $name = name_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationsApi()
name = name_example # String |  (default to null)

try:
    # Retrieve a default configuration.
    api_response = api_instance.get_default_configuration(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->getDefaultConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let name = name_example; // String

    let mut context = ConfigurationsApi::Context::default();
    let result = client.getDefaultConfiguration(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
Required

Responses

getDefaultConfigurations

Retrieve the lists of all default configurations.

Retrieve the lists of all default configurations.


/default_configurations

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/default_configurations"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationsApi apiInstance = new ConfigurationsApi();

        try {
            DefaultConfigurationList result = apiInstance.getDefaultConfigurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getDefaultConfigurations");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();

        try {
            DefaultConfigurationList result = apiInstance.getDefaultConfigurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getDefaultConfigurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];

// Retrieve the lists of all default configurations.
[apiInstance getDefaultConfigurationsWithCompletionHandler: 
              ^(DefaultConfigurationList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ConfigurationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefaultConfigurations(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDefaultConfigurationsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationsApi();

            try {
                // Retrieve the lists of all default configurations.
                DefaultConfigurationList result = apiInstance.getDefaultConfigurations();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.getDefaultConfigurations: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationsApi();

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationsApi->new();

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationsApi()

try:
    # Retrieve the lists of all default configurations.
    api_response = api_instance.get_default_configurations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->getDefaultConfigurations: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {

    let mut context = ConfigurationsApi::Context::default();
    let result = client.getDefaultConfigurations(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

updateDefaultConfiguration

Update a default configuration

Update a default configuration


/default_configuration/{name}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/default_configuration/{name}" \
 -d '{
  "configuration" : "configuration",
  "modelIds" : [ "modelIds", "modelIds" ],
  "created" : 0,
  "name" : "name",
  "description" : "description",
  "lastModified" : 6,
  "platform" : "ap"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 
        DefaultConfiguration defaultConfiguration = ; // DefaultConfiguration | 

        try {
            apiInstance.updateDefaultConfiguration(name, defaultConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#updateDefaultConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String name = name_example; // String | 
        DefaultConfiguration defaultConfiguration = ; // DefaultConfiguration | 

        try {
            apiInstance.updateDefaultConfiguration(name, defaultConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#updateDefaultConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
String *name = name_example; //  (default to null)
DefaultConfiguration *defaultConfiguration = ; //  (optional)

// Update a default configuration
[apiInstance updateDefaultConfigurationWith:name
    defaultConfiguration:defaultConfiguration
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ConfigurationsApi()
var name = name_example; // {String} 
var opts = {
  'defaultConfiguration':  // {DefaultConfiguration} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateDefaultConfiguration(name, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateDefaultConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ConfigurationsApi();
            var name = name_example;  // String |  (default to null)
            var defaultConfiguration = new DefaultConfiguration(); // DefaultConfiguration |  (optional) 

            try {
                // Update a default configuration
                apiInstance.updateDefaultConfiguration(name, defaultConfiguration);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.updateDefaultConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationsApi();
$name = name_example; // String | 
$defaultConfiguration = ; // DefaultConfiguration | 

try {
    $api_instance->updateDefaultConfiguration($name, $defaultConfiguration);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationsApi->updateDefaultConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationsApi->new();
my $name = name_example; # String | 
my $defaultConfiguration = WWW::OPenAPIClient::Object::DefaultConfiguration->new(); # DefaultConfiguration | 

eval {
    $api_instance->updateDefaultConfiguration(name => $name, defaultConfiguration => $defaultConfiguration);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->updateDefaultConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ConfigurationsApi()
name = name_example # String |  (default to null)
defaultConfiguration =  # DefaultConfiguration |  (optional)

try:
    # Update a default configuration
    api_instance.update_default_configuration(name, defaultConfiguration=defaultConfiguration)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->updateDefaultConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let name = name_example; // String
    let defaultConfiguration = ; // DefaultConfiguration

    let mut context = ConfigurationsApi::Context::default();
    let result = client.updateDefaultConfiguration(name, defaultConfiguration, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
Required
Body parameters
Name Description
defaultConfiguration

Configuration details

Responses

Dashboards

getDeviceDashboard

Get the last version of the dashboard.


/deviceDashboard

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/deviceDashboard"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsApi;

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

public class DashboardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DashboardsApi apiInstance = new DashboardsApi();

        try {
            apiInstance.getDeviceDashboard();
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDeviceDashboard");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DashboardsApi;

public class DashboardsApiExample {
    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();

        try {
            apiInstance.getDeviceDashboard();
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDeviceDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// Get the last version of the dashboard.
[apiInstance getDeviceDashboardWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DashboardsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDeviceDashboard(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceDashboardExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsApi();

            try {
                // Get the last version of the dashboard.
                apiInstance.getDeviceDashboard();
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsApi.getDeviceDashboard: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsApi();

try {
    $api_instance->getDeviceDashboard();
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->getDeviceDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsApi->new();

eval {
    $api_instance->getDeviceDashboard();
};
if ($@) {
    warn "Exception when calling DashboardsApi->getDeviceDashboard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DashboardsApi()

try:
    # Get the last version of the dashboard.
    api_instance.get_device_dashboard()
except ApiException as e:
    print("Exception when calling DashboardsApi->getDeviceDashboard: %s\n" % e)
extern crate DashboardsApi;

pub fn main() {

    let mut context = DashboardsApi::Context::default();
    let result = client.getDeviceDashboard(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Devices

createNewDevice

Create a new device.


/device/{serialNumber}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}?validateOnly=true" \
 -d '{
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "notes" : [ {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 6
  }, {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 6
  } ],
  "configuration" : "configuration",
  "lastConfigurationChange" : 5,
  "locale" : "locale",
  "manufacturer" : "manufacturer",
  "lastConfigurationDownload" : 5,
  "modified" : 2,
  "UUID" : 0,
  "firmware" : "firmware",
  "devicePassword" : "devicePassword",
  "owner" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serialNumber" : "serialNumber",
  "subscriber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "pendingConfiguration" : "pendingConfiguration",
  "createdTimestamp" : 1,
  "simulated" : true,
  "lastRecordedContact" : 9,
  "blackListed" : true,
  "macAddress" : "macAddress",
  "certificateExpiryDate" : 7,
  "pendingConfigurationCmd" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "restrictionDetails" : {
    "dfs" : true,
    "country" : [ "country", "country" ],
    "rtty" : true,
    "upgrade" : true,
    "key_info" : {
      "vendor" : "vendor",
      "algo" : "algo"
    },
    "tty" : true,
    "ssh" : true,
    "developer" : true,
    "commands" : true
  },
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "restrictedDevice" : false
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 
        Boolean validateOnly = true; // Boolean | 
        Device device = ; // Device | 

        try {
            Device result = apiInstance.createNewDevice(serialNumber, validateOnly, device);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#createNewDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 
        Boolean validateOnly = true; // Boolean | 
        Device device = ; // Device | 

        try {
            Device result = apiInstance.createNewDevice(serialNumber, validateOnly, device);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#createNewDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Boolean *validateOnly = true; //  (optional) (default to null)
Device *device = ; //  (optional)

// Create a new device.
[apiInstance createNewDeviceWith:serialNumber
    validateOnly:validateOnly
    device:device
              completionHandler: ^(Device output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'validateOnly': true, // {Boolean} 
  'device':  // {Device} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createNewDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var validateOnly = true;  // Boolean |  (optional)  (default to null)
            var device = new Device(); // Device |  (optional) 

            try {
                // Create a new device.
                Device result = apiInstance.createNewDevice(serialNumber, validateOnly, device);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.createNewDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();
$serialNumber = serialNumber_example; // String | 
$validateOnly = true; // Boolean | 
$device = ; // Device | 

try {
    $result = $api_instance->createNewDevice($serialNumber, $validateOnly, $device);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->createNewDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();
my $serialNumber = serialNumber_example; # String | 
my $validateOnly = true; # Boolean | 
my $device = WWW::OPenAPIClient::Object::Device->new(); # Device | 

eval {
    my $result = $api_instance->createNewDevice(serialNumber => $serialNumber, validateOnly => $validateOnly, device => $device);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->createNewDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()
serialNumber = serialNumber_example # String |  (default to null)
validateOnly = true # Boolean |  (optional) (default to null)
device =  # Device |  (optional)

try:
    # Create a new device.
    api_response = api_instance.create_new_device(serialNumber, validateOnly=validateOnly, device=device)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->createNewDevice: %s\n" % e)
extern crate DevicesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let validateOnly = true; // Boolean
    let device = ; // Device

    let mut context = DevicesApi::Context::default();
    let result = client.createNewDevice(serialNumber, validateOnly, device, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
device

Information used to create the new device
Query parameters
Name Description
validateOnly
Boolean

Responses

deleteDevice

Delete a single device.


/device/{serialNumber}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/device/{serialNumber}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            apiInstance.deleteDevice(serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            apiInstance.deleteDevice(serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Delete a single device.
[apiInstance deleteDeviceWith:serialNumber
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var serialNumber = serialNumber_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDevice(serialNumber, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Delete a single device.
                apiInstance.deleteDevice(serialNumber);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.deleteDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();
$serialNumber = serialNumber_example; // String | 

try {
    $api_instance->deleteDevice($serialNumber);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deleteDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();
my $serialNumber = serialNumber_example; # String | 

eval {
    $api_instance->deleteDevice(serialNumber => $serialNumber);
};
if ($@) {
    warn "Exception when calling DevicesApi->deleteDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Delete a single device.
    api_instance.delete_device(serialNumber)
except ApiException as e:
    print("Exception when calling DevicesApi->deleteDevice: %s\n" % e)
extern crate DevicesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = DevicesApi::Context::default();
    let result = client.deleteDevice(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

deleteDeviceList

Delete a list of devices matching a criteria

Delete a list of devices matching a criteria


/devices

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/devices?select=serial1,serial2,serial3&simulatedOnly=true&macPattern=["aabbcc*","*aabbcc*","*cccddee"]&oldestContact=789&simulatedDevices=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean simulatedOnly = true; // Boolean | Only simulated devices
        String macPattern = ["aabbcc*","*aabbcc*","*cccddee"]; // String | MAC address must match this pattern.  Mutually exclusive with oldestContact
        Long oldestContact = 789; // Long | lastRecordedContact older than this value. Mutually exclusive with macPattern
        Boolean simulatedDevices = true; // Boolean | Filter the results

        try {
            apiInstance.deleteDeviceList(select, simulatedOnly, macPattern, oldestContact, simulatedDevices);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDeviceList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean simulatedOnly = true; // Boolean | Only simulated devices
        String macPattern = ["aabbcc*","*aabbcc*","*cccddee"]; // String | MAC address must match this pattern.  Mutually exclusive with oldestContact
        Long oldestContact = 789; // Long | lastRecordedContact older than this value. Mutually exclusive with macPattern
        Boolean simulatedDevices = true; // Boolean | Filter the results

        try {
            apiInstance.deleteDeviceList(select, simulatedOnly, macPattern, oldestContact, simulatedDevices);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDeviceList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *simulatedOnly = true; // Only simulated devices (optional) (default to false)
String *macPattern = ["aabbcc*","*aabbcc*","*cccddee"]; // MAC address must match this pattern.  Mutually exclusive with oldestContact (optional) (default to null)
Long *oldestContact = 789; // lastRecordedContact older than this value. Mutually exclusive with macPattern (optional) (default to null)
Boolean *simulatedDevices = true; // Filter the results (optional) (default to null)

// Delete a list of devices matching a criteria
[apiInstance deleteDeviceListWith:select
    simulatedOnly:simulatedOnly
    macPattern:macPattern
    oldestContact:oldestContact
    simulatedDevices:simulatedDevices
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var opts = {
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'simulatedOnly': true, // {Boolean} Only simulated devices
  'macPattern': ["aabbcc*","*aabbcc*","*cccddee"], // {String} MAC address must match this pattern.  Mutually exclusive with oldestContact
  'oldestContact': 789, // {Long} lastRecordedContact older than this value. Mutually exclusive with macPattern
  'simulatedDevices': true // {Boolean} Filter the results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDeviceList(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDeviceListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();
            var select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var simulatedOnly = true;  // Boolean | Only simulated devices (optional)  (default to false)
            var macPattern = ["aabbcc*","*aabbcc*","*cccddee"];  // String | MAC address must match this pattern.  Mutually exclusive with oldestContact (optional)  (default to null)
            var oldestContact = 789;  // Long | lastRecordedContact older than this value. Mutually exclusive with macPattern (optional)  (default to null)
            var simulatedDevices = true;  // Boolean | Filter the results (optional)  (default to null)

            try {
                // Delete a list of devices matching a criteria
                apiInstance.deleteDeviceList(select, simulatedOnly, macPattern, oldestContact, simulatedDevices);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.deleteDeviceList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$simulatedOnly = true; // Boolean | Only simulated devices
$macPattern = ["aabbcc*","*aabbcc*","*cccddee"]; // String | MAC address must match this pattern.  Mutually exclusive with oldestContact
$oldestContact = 789; // Long | lastRecordedContact older than this value. Mutually exclusive with macPattern
$simulatedDevices = true; // Boolean | Filter the results

try {
    $api_instance->deleteDeviceList($select, $simulatedOnly, $macPattern, $oldestContact, $simulatedDevices);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deleteDeviceList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();
my $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $simulatedOnly = true; # Boolean | Only simulated devices
my $macPattern = ["aabbcc*","*aabbcc*","*cccddee"]; # String | MAC address must match this pattern.  Mutually exclusive with oldestContact
my $oldestContact = 789; # Long | lastRecordedContact older than this value. Mutually exclusive with macPattern
my $simulatedDevices = true; # Boolean | Filter the results

eval {
    $api_instance->deleteDeviceList(select => $select, simulatedOnly => $simulatedOnly, macPattern => $macPattern, oldestContact => $oldestContact, simulatedDevices => $simulatedDevices);
};
if ($@) {
    warn "Exception when calling DevicesApi->deleteDeviceList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
simulatedOnly = true # Boolean | Only simulated devices (optional) (default to false)
macPattern = ["aabbcc*","*aabbcc*","*cccddee"] # String | MAC address must match this pattern.  Mutually exclusive with oldestContact (optional) (default to null)
oldestContact = 789 # Long | lastRecordedContact older than this value. Mutually exclusive with macPattern (optional) (default to null)
simulatedDevices = true # Boolean | Filter the results (optional) (default to null)

try:
    # Delete a list of devices matching a criteria
    api_instance.delete_device_list(select=select, simulatedOnly=simulatedOnly, macPattern=macPattern, oldestContact=oldestContact, simulatedDevices=simulatedDevices)
except ApiException as e:
    print("Exception when calling DevicesApi->deleteDeviceList: %s\n" % e)
extern crate DevicesApi;

pub fn main() {
    let select = serial1,serial2,serial3; // String
    let simulatedOnly = true; // Boolean
    let macPattern = ["aabbcc*","*aabbcc*","*cccddee"]; // String
    let oldestContact = 789; // Long
    let simulatedDevices = true; // Boolean

    let mut context = DevicesApi::Context::default();
    let result = client.deleteDeviceList(select, simulatedOnly, macPattern, oldestContact, simulatedDevices, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
select
String
Supply a list of devices comma separated
simulatedOnly
Boolean
Only simulated devices
macPattern
String
MAC address must match this pattern. Mutually exclusive with oldestContact
oldestContact
Long (int64)
lastRecordedContact older than this value. Mutually exclusive with macPattern
simulatedDevices
Boolean
Filter the results

Responses

getCapabilitiesList

Get the list of device types and capabilities.


/capabilities

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/capabilities"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();

        try {
            CapabilitiesModelList result = apiInstance.getCapabilitiesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getCapabilitiesList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();

        try {
            CapabilitiesModelList result = apiInstance.getCapabilitiesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getCapabilitiesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];

// Get the list of device types and capabilities.
[apiInstance getCapabilitiesListWithCompletionHandler: 
              ^(CapabilitiesModelList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCapabilitiesList(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCapabilitiesListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();

            try {
                // Get the list of device types and capabilities.
                CapabilitiesModelList result = apiInstance.getCapabilitiesList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.getCapabilitiesList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()

try:
    # Get the list of device types and capabilities.
    api_response = api_instance.get_capabilities_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->getCapabilitiesList: %s\n" % e)
extern crate DevicesApi;

pub fn main() {

    let mut context = DevicesApi::Context::default();
    let result = client.getCapabilitiesList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

getDeviceInformation

Retrieve information for a single device.

Retrieve all the inforamtion about a single device


/device/{serialNumber}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            Device result = apiInstance.getDeviceInformation(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceInformation");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            Device result = apiInstance.getDeviceInformation(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceInformation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// Retrieve information for a single device.
[apiInstance getDeviceInformationWith:serialNumber
              completionHandler: ^(Device output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var serialNumber = serialNumber_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceInformationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Retrieve information for a single device.
                Device result = apiInstance.getDeviceInformation(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.getDeviceInformation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();
$serialNumber = serialNumber_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();
my $serialNumber = serialNumber_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Retrieve information for a single device.
    api_response = api_instance.get_device_information(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->getDeviceInformation: %s\n" % e)
extern crate DevicesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = DevicesApi::Context::default();
    let result = client.getDeviceInformation(serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses

getDeviceList

Returns a list of devices.

Get a list of devices.


/devices

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/devices?offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&serialOnly=true&countOnly=false&deviceWithStatus=true&orderBy=serialNumber:a,created:d&orderSpec=true&connectionStatistics=true&health=true&lowLimit=56&highLimits=56&platform=platform_example&includeProvisioned=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean serialOnly = true; // Boolean | only serial numbers of full device details
        Boolean countOnly = false; // Boolean | return the number of devices
        Boolean deviceWithStatus = true; // Boolean | Return extra information with the device information
        String orderBy = serialNumber:a,created:d; // String | return extended information
        Boolean orderSpec = true; // Boolean | return extended information
        Boolean connectionStatistics = true; // Boolean | return extended information
        Boolean health = true; // Boolean | return devices with their health value in between lowLimit and highLimit
        Integer lowLimit = 56; // Integer | lowLimit for the health selection criteria
        Integer highLimits = 56; // Integer | highLimit for the health selection criteria
        String platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH
        Boolean includeProvisioned = true; // Boolean | only devices which are not provisioned

        try {
            getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceList");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean serialOnly = true; // Boolean | only serial numbers of full device details
        Boolean countOnly = false; // Boolean | return the number of devices
        Boolean deviceWithStatus = true; // Boolean | Return extra information with the device information
        String orderBy = serialNumber:a,created:d; // String | return extended information
        Boolean orderSpec = true; // Boolean | return extended information
        Boolean connectionStatistics = true; // Boolean | return extended information
        Boolean health = true; // Boolean | return devices with their health value in between lowLimit and highLimit
        Integer lowLimit = 56; // Integer | lowLimit for the health selection criteria
        Integer highLimits = 56; // Integer | highLimit for the health selection criteria
        String platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH
        Boolean includeProvisioned = true; // Boolean | only devices which are not provisioned

        try {
            getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];
Integer *offset = 56; // Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *serialOnly = true; // only serial numbers of full device details (optional) (default to null)
Boolean *countOnly = false; // return the number of devices (optional) (default to null)
Boolean *deviceWithStatus = true; // Return extra information with the device information (optional) (default to null)
String *orderBy = serialNumber:a,created:d; // return extended information (optional) (default to null)
Boolean *orderSpec = true; // return extended information (optional) (default to false)
Boolean *connectionStatistics = true; // return extended information (optional) (default to false)
Boolean *health = true; // return devices with their health value in between lowLimit and highLimit (optional) (default to false)
Integer *lowLimit = 56; // lowLimit for the health selection criteria (optional) (default to 30)
Integer *highLimits = 56; // highLimit for the health selection criteria (optional) (default to 70)
String *platform = platform_example; // return only devices matching a certain platform of AP or SWITCH (optional) (default to ALL)
Boolean *includeProvisioned = true; // only devices which are not provisioned (optional) (default to null)

// Returns a list of devices.
[apiInstance getDeviceListWith:offset
    limit:limit
    filter:filter
    select:select
    serialOnly:serialOnly
    countOnly:countOnly
    deviceWithStatus:deviceWithStatus
    orderBy:orderBy
    orderSpec:orderSpec
    connectionStatistics:connectionStatistics
    health:health
    lowLimit:lowLimit
    highLimits:highLimits
    platform:platform
    includeProvisioned:includeProvisioned
              completionHandler: ^(getDeviceList_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var opts = {
  'offset': 56, // {Integer} Pagination start (starts at 1. If not specified, 1 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'filter': filter_example, // {String} Filter the results
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'serialOnly': true, // {Boolean} only serial numbers of full device details
  'countOnly': false, // {Boolean} return the number of devices
  'deviceWithStatus': true, // {Boolean} Return extra information with the device information
  'orderBy': serialNumber:a,created:d, // {String} return extended information
  'orderSpec': true, // {Boolean} return extended information
  'connectionStatistics': true, // {Boolean} return extended information
  'health': true, // {Boolean} return devices with their health value in between lowLimit and highLimit
  'lowLimit': 56, // {Integer} lowLimit for the health selection criteria
  'highLimits': 56, // {Integer} highLimit for the health selection criteria
  'platform': platform_example, // {String} return only devices matching a certain platform of AP or SWITCH
  'includeProvisioned': true // {Boolean} only devices which are not provisioned
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();
            var offset = 56;  // Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var serialOnly = true;  // Boolean | only serial numbers of full device details (optional)  (default to null)
            var countOnly = false;  // Boolean | return the number of devices (optional)  (default to null)
            var deviceWithStatus = true;  // Boolean | Return extra information with the device information (optional)  (default to null)
            var orderBy = serialNumber:a,created:d;  // String | return extended information (optional)  (default to null)
            var orderSpec = true;  // Boolean | return extended information (optional)  (default to false)
            var connectionStatistics = true;  // Boolean | return extended information (optional)  (default to false)
            var health = true;  // Boolean | return devices with their health value in between lowLimit and highLimit (optional)  (default to false)
            var lowLimit = 56;  // Integer | lowLimit for the health selection criteria (optional)  (default to 30)
            var highLimits = 56;  // Integer | highLimit for the health selection criteria (optional)  (default to 70)
            var platform = platform_example;  // String | return only devices matching a certain platform of AP or SWITCH (optional)  (default to ALL)
            var includeProvisioned = true;  // Boolean | only devices which are not provisioned (optional)  (default to null)

            try {
                // Returns a list of devices.
                getDeviceList_200_response result = apiInstance.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.getDeviceList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();
$offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$filter = filter_example; // String | Filter the results
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$serialOnly = true; // Boolean | only serial numbers of full device details
$countOnly = false; // Boolean | return the number of devices
$deviceWithStatus = true; // Boolean | Return extra information with the device information
$orderBy = serialNumber:a,created:d; // String | return extended information
$orderSpec = true; // Boolean | return extended information
$connectionStatistics = true; // Boolean | return extended information
$health = true; // Boolean | return devices with their health value in between lowLimit and highLimit
$lowLimit = 56; // Integer | lowLimit for the health selection criteria
$highLimits = 56; // Integer | highLimit for the health selection criteria
$platform = platform_example; // String | return only devices matching a certain platform of AP or SWITCH
$includeProvisioned = true; // Boolean | only devices which are not provisioned

try {
    $result = $api_instance->getDeviceList($offset, $limit, $filter, $select, $serialOnly, $countOnly, $deviceWithStatus, $orderBy, $orderSpec, $connectionStatistics, $health, $lowLimit, $highLimits, $platform, $includeProvisioned);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->getDeviceList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();
my $offset = 56; # Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $filter = filter_example; # String | Filter the results
my $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $serialOnly = true; # Boolean | only serial numbers of full device details
my $countOnly = false; # Boolean | return the number of devices
my $deviceWithStatus = true; # Boolean | Return extra information with the device information
my $orderBy = serialNumber:a,created:d; # String | return extended information
my $orderSpec = true; # Boolean | return extended information
my $connectionStatistics = true; # Boolean | return extended information
my $health = true; # Boolean | return devices with their health value in between lowLimit and highLimit
my $lowLimit = 56; # Integer | lowLimit for the health selection criteria
my $highLimits = 56; # Integer | highLimit for the health selection criteria
my $platform = platform_example; # String | return only devices matching a certain platform of AP or SWITCH
my $includeProvisioned = true; # Boolean | only devices which are not provisioned

eval {
    my $result = $api_instance->getDeviceList(offset => $offset, limit => $limit, filter => $filter, select => $select, serialOnly => $serialOnly, countOnly => $countOnly, deviceWithStatus => $deviceWithStatus, orderBy => $orderBy, orderSpec => $orderSpec, connectionStatistics => $connectionStatistics, health => $health, lowLimit => $lowLimit, highLimits => $highLimits, platform => $platform, includeProvisioned => $includeProvisioned);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getDeviceList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()
offset = 56 # Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
serialOnly = true # Boolean | only serial numbers of full device details (optional) (default to null)
countOnly = false # Boolean | return the number of devices (optional) (default to null)
deviceWithStatus = true # Boolean | Return extra information with the device information (optional) (default to null)
orderBy = serialNumber:a,created:d # String | return extended information (optional) (default to null)
orderSpec = true # Boolean | return extended information (optional) (default to false)
connectionStatistics = true # Boolean | return extended information (optional) (default to false)
health = true # Boolean | return devices with their health value in between lowLimit and highLimit (optional) (default to false)
lowLimit = 56 # Integer | lowLimit for the health selection criteria (optional) (default to 30)
highLimits = 56 # Integer | highLimit for the health selection criteria (optional) (default to 70)
platform = platform_example # String | return only devices matching a certain platform of AP or SWITCH (optional) (default to ALL)
includeProvisioned = true # Boolean | only devices which are not provisioned (optional) (default to null)

try:
    # Returns a list of devices.
    api_response = api_instance.get_device_list(offset=offset, limit=limit, filter=filter, select=select, serialOnly=serialOnly, countOnly=countOnly, deviceWithStatus=deviceWithStatus, orderBy=orderBy, orderSpec=orderSpec, connectionStatistics=connectionStatistics, health=health, lowLimit=lowLimit, highLimits=highLimits, platform=platform, includeProvisioned=includeProvisioned)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->getDeviceList: %s\n" % e)
extern crate DevicesApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let serialOnly = true; // Boolean
    let countOnly = false; // Boolean
    let deviceWithStatus = true; // Boolean
    let orderBy = serialNumber:a,created:d; // String
    let orderSpec = true; // Boolean
    let connectionStatistics = true; // Boolean
    let health = true; // Boolean
    let lowLimit = 56; // Integer
    let highLimits = 56; // Integer
    let platform = platform_example; // String
    let includeProvisioned = true; // Boolean

    let mut context = DevicesApi::Context::default();
    let result = client.getDeviceList(offset, limit, filter, select, serialOnly, countOnly, deviceWithStatus, orderBy, orderSpec, connectionStatistics, health, lowLimit, highLimits, platform, includeProvisioned, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Pagination start (starts at 1. If not specified, 1 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
filter
String
Filter the results
select
String
Supply a list of devices comma separated
serialOnly
Boolean
only serial numbers of full device details
countOnly
Boolean
return the number of devices
deviceWithStatus
Boolean
Return extra information with the device information
orderBy
String
return extended information
orderSpec
Boolean
return extended information
connectionStatistics
Boolean
return extended information
health
Boolean
return devices with their health value in between lowLimit and highLimit
lowLimit
Integer
lowLimit for the health selection criteria
highLimits
Integer
highLimit for the health selection criteria
platform
String
return only devices matching a certain platform of AP or SWITCH
includeProvisioned
Boolean
only devices which are not provisioned

Responses

updateNewDevice

Update a device.


/device/{serialNumber}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/device/{serialNumber}" \
 -d '{
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "notes" : [ {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 6
  }, {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 6
  } ],
  "configuration" : "configuration",
  "lastConfigurationChange" : 5,
  "locale" : "locale",
  "manufacturer" : "manufacturer",
  "lastConfigurationDownload" : 5,
  "modified" : 2,
  "UUID" : 0,
  "firmware" : "firmware",
  "devicePassword" : "devicePassword",
  "owner" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serialNumber" : "serialNumber",
  "subscriber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "pendingConfiguration" : "pendingConfiguration",
  "createdTimestamp" : 1,
  "simulated" : true,
  "lastRecordedContact" : 9,
  "blackListed" : true,
  "macAddress" : "macAddress",
  "certificateExpiryDate" : 7,
  "pendingConfigurationCmd" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "restrictionDetails" : {
    "dfs" : true,
    "country" : [ "country", "country" ],
    "rtty" : true,
    "upgrade" : true,
    "key_info" : {
      "vendor" : "vendor",
      "algo" : "algo"
    },
    "tty" : true,
    "ssh" : true,
    "developer" : true,
    "commands" : true
  },
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "restrictedDevice" : false
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesApi;

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

public class DevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 
        Device device = ; // Device | 

        try {
            Device result = apiInstance.updateNewDevice(serialNumber, device);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#updateNewDevice");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.DevicesApi;

public class DevicesApiExample {
    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String serialNumber = serialNumber_example; // String | 
        Device device = ; // Device | 

        try {
            Device result = apiInstance.updateNewDevice(serialNumber, device);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#updateNewDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
DevicesApi *apiInstance = [[DevicesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
Device *device = ; //  (optional)

// Update a device.
[apiInstance updateNewDeviceWith:serialNumber
    device:device
              completionHandler: ^(Device output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.DevicesApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'device':  // {Device} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateNewDeviceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var device = new Device(); // Device |  (optional) 

            try {
                // Update a device.
                Device result = apiInstance.updateNewDevice(serialNumber, device);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesApi.updateNewDevice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesApi();
$serialNumber = serialNumber_example; // String | 
$device = ; // Device | 

try {
    $result = $api_instance->updateNewDevice($serialNumber, $device);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->updateNewDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesApi->new();
my $serialNumber = serialNumber_example; # String | 
my $device = WWW::OPenAPIClient::Object::Device->new(); # Device | 

eval {
    my $result = $api_instance->updateNewDevice(serialNumber => $serialNumber, device => $device);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->updateNewDevice: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.DevicesApi()
serialNumber = serialNumber_example # String |  (default to null)
device =  # Device |  (optional)

try:
    # Update a device.
    api_response = api_instance.update_new_device(serialNumber, device=device)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevicesApi->updateNewDevice: %s\n" % e)
extern crate DevicesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let device = ; // Device

    let mut context = DevicesApi::Context::default();
    let result = client.updateNewDevice(serialNumber, device, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
device

Information used to create the new device

Responses

Files

deleteUploadFidelete

Delete a file from the upload directory.


/file/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/file/{uuid}?serialNumber=serialNumber_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

public class FilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String serialNumber = serialNumber_example; // String | 

        try {
            apiInstance.deleteUploadFidelete(uuid, serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#deleteUploadFidelete");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String serialNumber = serialNumber_example; // String | 

        try {
            apiInstance.deleteUploadFidelete(uuid, serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#deleteUploadFidelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *serialNumber = serialNumber_example; //  (default to null)

// Delete a file from the upload directory.
[apiInstance deleteUploadFideleteWith:uuid
    serialNumber:serialNumber
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FilesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var serialNumber = serialNumber_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUploadFidelete(uuid, serialNumber, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUploadFideleteExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Delete a file from the upload directory.
                apiInstance.deleteUploadFidelete(uuid, serialNumber);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.deleteUploadFidelete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$serialNumber = serialNumber_example; // String | 

try {
    $api_instance->deleteUploadFidelete($uuid, $serialNumber);
} catch (Exception $e) {
    echo 'Exception when calling FilesApi->deleteUploadFidelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $serialNumber = serialNumber_example; # String | 

eval {
    $api_instance->deleteUploadFidelete(uuid => $uuid, serialNumber => $serialNumber);
};
if ($@) {
    warn "Exception when calling FilesApi->deleteUploadFidelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Delete a file from the upload directory.
    api_instance.delete_upload_fidelete(uuid, serialNumber)
except ApiException as e:
    print("Exception when calling FilesApi->deleteUploadFidelete: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let serialNumber = serialNumber_example; // String

    let mut context = FilesApi::Context::default();
    let result = client.deleteUploadFidelete(uuid, serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
serialNumber*
String
Required

Responses

getUploadFile

Get a file from the upload directory.


/file/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/octet-stream" \
 "https://localhost:16002/api/v1/file/{uuid}?serialNumber=serialNumber_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

public class FilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String serialNumber = serialNumber_example; // String | 

        try {
            File result = apiInstance.getUploadFile(uuid, serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getUploadFile");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String serialNumber = serialNumber_example; // String | 

        try {
            File result = apiInstance.getUploadFile(uuid, serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getUploadFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *serialNumber = serialNumber_example; //  (default to null)

// Get a file from the upload directory.
[apiInstance getUploadFileWith:uuid
    serialNumber:serialNumber
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FilesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var serialNumber = serialNumber_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUploadFileExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // Get a file from the upload directory.
                File result = apiInstance.getUploadFile(uuid, serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.getUploadFile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$serialNumber = serialNumber_example; // String | 

try {
    $result = $api_instance->getUploadFile($uuid, $serialNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilesApi->getUploadFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $serialNumber = serialNumber_example; # String | 

eval {
    my $result = $api_instance->getUploadFile(uuid => $uuid, serialNumber => $serialNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilesApi->getUploadFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
serialNumber = serialNumber_example # String |  (default to null)

try:
    # Get a file from the upload directory.
    api_response = api_instance.get_upload_file(uuid, serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->getUploadFile: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let serialNumber = serialNumber_example; // String

    let mut context = FilesApi::Context::default();
    let result = client.getUploadFile(uuid, serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
serialNumber*
String
Required

Responses

Firmware

createDefaultFirmware

Create a default firmware.

Create a default firmware.


/default_firmware/{deviceType}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/default_firmware/{deviceType}" \
 -d '{
  "deviceType" : "deviceType",
  "created" : 6,
  "description" : "description",
  "lastModified" : 1,
  "uri" : "uri",
  "imageCreationDate" : 0,
  "revision" : "revision"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareApi;

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

public class FirmwareApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 
        DefaultFirmware defaultFirmware = ; // DefaultFirmware | 

        try {
            apiInstance.createDefaultFirmware(deviceType, defaultFirmware);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#createDefaultFirmware");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FirmwareApi;

public class FirmwareApiExample {
    public static void main(String[] args) {
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 
        DefaultFirmware defaultFirmware = ; // DefaultFirmware | 

        try {
            apiInstance.createDefaultFirmware(deviceType, defaultFirmware);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#createDefaultFirmware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareApi *apiInstance = [[FirmwareApi alloc] init];
String *deviceType = deviceType_example; //  (default to null)
DefaultFirmware *defaultFirmware = ; //  (optional)

// Create a default firmware.
[apiInstance createDefaultFirmwareWith:deviceType
    defaultFirmware:defaultFirmware
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FirmwareApi()
var deviceType = deviceType_example; // {String} 
var opts = {
  'defaultFirmware':  // {DefaultFirmware} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createDefaultFirmware(deviceType, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createDefaultFirmwareExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FirmwareApi();
            var deviceType = deviceType_example;  // String |  (default to null)
            var defaultFirmware = new DefaultFirmware(); // DefaultFirmware |  (optional) 

            try {
                // Create a default firmware.
                apiInstance.createDefaultFirmware(deviceType, defaultFirmware);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareApi.createDefaultFirmware: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareApi();
$deviceType = deviceType_example; // String | 
$defaultFirmware = ; // DefaultFirmware | 

try {
    $api_instance->createDefaultFirmware($deviceType, $defaultFirmware);
} catch (Exception $e) {
    echo 'Exception when calling FirmwareApi->createDefaultFirmware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FirmwareApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareApi->new();
my $deviceType = deviceType_example; # String | 
my $defaultFirmware = WWW::OPenAPIClient::Object::DefaultFirmware->new(); # DefaultFirmware | 

eval {
    $api_instance->createDefaultFirmware(deviceType => $deviceType, defaultFirmware => $defaultFirmware);
};
if ($@) {
    warn "Exception when calling FirmwareApi->createDefaultFirmware: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FirmwareApi()
deviceType = deviceType_example # String |  (default to null)
defaultFirmware =  # DefaultFirmware |  (optional)

try:
    # Create a default firmware.
    api_instance.create_default_firmware(deviceType, defaultFirmware=defaultFirmware)
except ApiException as e:
    print("Exception when calling FirmwareApi->createDefaultFirmware: %s\n" % e)
extern crate FirmwareApi;

pub fn main() {
    let deviceType = deviceType_example; // String
    let defaultFirmware = ; // DefaultFirmware

    let mut context = FirmwareApi::Context::default();
    let result = client.createDefaultFirmware(deviceType, defaultFirmware, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceType*
String
Required
Body parameters
Name Description
defaultFirmware

Information used to create the new firmware entry

Responses

deleteDefaultFirmware

Delete a default default firmware

Delete a default default firmware


/default_firmware/{deviceType}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/default_firmware/{deviceType}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareApi;

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

public class FirmwareApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 

        try {
            apiInstance.deleteDefaultFirmware(deviceType);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#deleteDefaultFirmware");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FirmwareApi;

public class FirmwareApiExample {
    public static void main(String[] args) {
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 

        try {
            apiInstance.deleteDefaultFirmware(deviceType);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#deleteDefaultFirmware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareApi *apiInstance = [[FirmwareApi alloc] init];
String *deviceType = deviceType_example; //  (default to null)

// Delete a default default firmware
[apiInstance deleteDefaultFirmwareWith:deviceType
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FirmwareApi()
var deviceType = deviceType_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDefaultFirmware(deviceType, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDefaultFirmwareExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FirmwareApi();
            var deviceType = deviceType_example;  // String |  (default to null)

            try {
                // Delete a default default firmware
                apiInstance.deleteDefaultFirmware(deviceType);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareApi.deleteDefaultFirmware: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareApi();
$deviceType = deviceType_example; // String | 

try {
    $api_instance->deleteDefaultFirmware($deviceType);
} catch (Exception $e) {
    echo 'Exception when calling FirmwareApi->deleteDefaultFirmware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FirmwareApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareApi->new();
my $deviceType = deviceType_example; # String | 

eval {
    $api_instance->deleteDefaultFirmware(deviceType => $deviceType);
};
if ($@) {
    warn "Exception when calling FirmwareApi->deleteDefaultFirmware: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FirmwareApi()
deviceType = deviceType_example # String |  (default to null)

try:
    # Delete a default default firmware
    api_instance.delete_default_firmware(deviceType)
except ApiException as e:
    print("Exception when calling FirmwareApi->deleteDefaultFirmware: %s\n" % e)
extern crate FirmwareApi;

pub fn main() {
    let deviceType = deviceType_example; // String

    let mut context = FirmwareApi::Context::default();
    let result = client.deleteDefaultFirmware(deviceType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceType*
String
Required

Responses

getDefaultFirmware

Retrieve a default firmware.

Retrieve a default firmware.


/default_firmware/{deviceType}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/default_firmware/{deviceType}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareApi;

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

public class FirmwareApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 

        try {
            DefaultFirmware result = apiInstance.getDefaultFirmware(deviceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#getDefaultFirmware");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FirmwareApi;

public class FirmwareApiExample {
    public static void main(String[] args) {
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 

        try {
            DefaultFirmware result = apiInstance.getDefaultFirmware(deviceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#getDefaultFirmware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareApi *apiInstance = [[FirmwareApi alloc] init];
String *deviceType = deviceType_example; //  (default to null)

// Retrieve a default firmware.
[apiInstance getDefaultFirmwareWith:deviceType
              completionHandler: ^(DefaultFirmware output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FirmwareApi()
var deviceType = deviceType_example; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDefaultFirmwareExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FirmwareApi();
            var deviceType = deviceType_example;  // String |  (default to null)

            try {
                // Retrieve a default firmware.
                DefaultFirmware result = apiInstance.getDefaultFirmware(deviceType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareApi.getDefaultFirmware: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareApi();
$deviceType = deviceType_example; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareApi->new();
my $deviceType = deviceType_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FirmwareApi()
deviceType = deviceType_example # String |  (default to null)

try:
    # Retrieve a default firmware.
    api_response = api_instance.get_default_firmware(deviceType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FirmwareApi->getDefaultFirmware: %s\n" % e)
extern crate FirmwareApi;

pub fn main() {
    let deviceType = deviceType_example; // String

    let mut context = FirmwareApi::Context::default();
    let result = client.getDefaultFirmware(deviceType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceType*
String
Required

Responses

getDefaultFirmwares

Retrieve the lists of all default firmwares.

Retrieve the lists of all default firmwares.


/default_firmwares

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/default_firmwares"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareApi;

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

public class FirmwareApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FirmwareApi apiInstance = new FirmwareApi();

        try {
            DefaultFirmwareList result = apiInstance.getDefaultFirmwares();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#getDefaultFirmwares");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FirmwareApi;

public class FirmwareApiExample {
    public static void main(String[] args) {
        FirmwareApi apiInstance = new FirmwareApi();

        try {
            DefaultFirmwareList result = apiInstance.getDefaultFirmwares();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#getDefaultFirmwares");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareApi *apiInstance = [[FirmwareApi alloc] init];

// Retrieve the lists of all default firmwares.
[apiInstance getDefaultFirmwaresWithCompletionHandler: 
              ^(DefaultFirmwareList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FirmwareApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefaultFirmwares(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDefaultFirmwaresExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FirmwareApi();

            try {
                // Retrieve the lists of all default firmwares.
                DefaultFirmwareList result = apiInstance.getDefaultFirmwares();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareApi.getDefaultFirmwares: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareApi();

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareApi->new();

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FirmwareApi()

try:
    # Retrieve the lists of all default firmwares.
    api_response = api_instance.get_default_firmwares()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FirmwareApi->getDefaultFirmwares: %s\n" % e)
extern crate FirmwareApi;

pub fn main() {

    let mut context = FirmwareApi::Context::default();
    let result = client.getDefaultFirmwares(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

updateDefaultFirmware

Update a default firmware

Update a default firmware


/default_firmware/{deviceType}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/default_firmware/{deviceType}" \
 -d '{
  "deviceType" : "deviceType",
  "created" : 6,
  "description" : "description",
  "lastModified" : 1,
  "uri" : "uri",
  "imageCreationDate" : 0,
  "revision" : "revision"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareApi;

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

public class FirmwareApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 
        DefaultFirmware defaultFirmware = ; // DefaultFirmware | 

        try {
            apiInstance.updateDefaultFirmware(deviceType, defaultFirmware);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#updateDefaultFirmware");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.FirmwareApi;

public class FirmwareApiExample {
    public static void main(String[] args) {
        FirmwareApi apiInstance = new FirmwareApi();
        String deviceType = deviceType_example; // String | 
        DefaultFirmware defaultFirmware = ; // DefaultFirmware | 

        try {
            apiInstance.updateDefaultFirmware(deviceType, defaultFirmware);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareApi#updateDefaultFirmware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareApi *apiInstance = [[FirmwareApi alloc] init];
String *deviceType = deviceType_example; //  (default to null)
DefaultFirmware *defaultFirmware = ; //  (optional)

// Update a default firmware
[apiInstance updateDefaultFirmwareWith:deviceType
    defaultFirmware:defaultFirmware
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.FirmwareApi()
var deviceType = deviceType_example; // {String} 
var opts = {
  'defaultFirmware':  // {DefaultFirmware} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateDefaultFirmware(deviceType, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateDefaultFirmwareExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FirmwareApi();
            var deviceType = deviceType_example;  // String |  (default to null)
            var defaultFirmware = new DefaultFirmware(); // DefaultFirmware |  (optional) 

            try {
                // Update a default firmware
                apiInstance.updateDefaultFirmware(deviceType, defaultFirmware);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareApi.updateDefaultFirmware: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareApi();
$deviceType = deviceType_example; // String | 
$defaultFirmware = ; // DefaultFirmware | 

try {
    $api_instance->updateDefaultFirmware($deviceType, $defaultFirmware);
} catch (Exception $e) {
    echo 'Exception when calling FirmwareApi->updateDefaultFirmware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FirmwareApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareApi->new();
my $deviceType = deviceType_example; # String | 
my $defaultFirmware = WWW::OPenAPIClient::Object::DefaultFirmware->new(); # DefaultFirmware | 

eval {
    $api_instance->updateDefaultFirmware(deviceType => $deviceType, defaultFirmware => $defaultFirmware);
};
if ($@) {
    warn "Exception when calling FirmwareApi->updateDefaultFirmware: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FirmwareApi()
deviceType = deviceType_example # String |  (default to null)
defaultFirmware =  # DefaultFirmware |  (optional)

try:
    # Update a default firmware
    api_instance.update_default_firmware(deviceType, defaultFirmware=defaultFirmware)
except ApiException as e:
    print("Exception when calling FirmwareApi->updateDefaultFirmware: %s\n" % e)
extern crate FirmwareApi;

pub fn main() {
    let deviceType = deviceType_example; // String
    let defaultFirmware = ; // DefaultFirmware

    let mut context = FirmwareApi::Context::default();
    let result = client.updateDefaultFirmware(deviceType, defaultFirmware, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
deviceType*
String
Required
Body parameters
Name Description
defaultFirmware

Firmware details

Responses

OUIs

getOUIs

Get a list of OUIs.


/ouis

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/ouis?macList=macList_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OUIsApi;

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

public class OUIsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OUIsApi apiInstance = new OUIsApi();
        String macList = macList_example; // String | 

        try {
            apiInstance.getOUIs(macList);
        } catch (ApiException e) {
            System.err.println("Exception when calling OUIsApi#getOUIs");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.OUIsApi;

public class OUIsApiExample {
    public static void main(String[] args) {
        OUIsApi apiInstance = new OUIsApi();
        String macList = macList_example; // String | 

        try {
            apiInstance.getOUIs(macList);
        } catch (ApiException e) {
            System.err.println("Exception when calling OUIsApi#getOUIs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OUIsApi *apiInstance = [[OUIsApi alloc] init];
String *macList = macList_example; //  (default to null)

// Get a list of OUIs.
[apiInstance getOUIsWith:macList
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.OUIsApi()
var macList = macList_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getOUIs(macList, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getOUIsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OUIsApi();
            var macList = macList_example;  // String |  (default to null)

            try {
                // Get a list of OUIs.
                apiInstance.getOUIs(macList);
            } catch (Exception e) {
                Debug.Print("Exception when calling OUIsApi.getOUIs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OUIsApi();
$macList = macList_example; // String | 

try {
    $api_instance->getOUIs($macList);
} catch (Exception $e) {
    echo 'Exception when calling OUIsApi->getOUIs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OUIsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OUIsApi->new();
my $macList = macList_example; # String | 

eval {
    $api_instance->getOUIs(macList => $macList);
};
if ($@) {
    warn "Exception when calling OUIsApi->getOUIs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OUIsApi()
macList = macList_example # String |  (default to null)

try:
    # Get a list of OUIs.
    api_instance.get_ouis(macList)
except ApiException as e:
    print("Exception when calling OUIsApi->getOUIs: %s\n" % e)
extern crate OUIsApi;

pub fn main() {
    let macList = macList_example; // String

    let mut context = OUIsApi::Context::default();
    let result = client.getOUIs(macList, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
macList*
String
Required

Responses

RADIUSProxy

deleteRadiusProxyConfig

Delete RADIUS Proxy configuration.


/radiusProxyConfig

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/radiusProxyConfig"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RADIUSProxyApi;

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

public class RADIUSProxyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RADIUSProxyApi apiInstance = new RADIUSProxyApi();

        try {
            apiInstance.deleteRadiusProxyConfig();
        } catch (ApiException e) {
            System.err.println("Exception when calling RADIUSProxyApi#deleteRadiusProxyConfig");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.RADIUSProxyApi;

public class RADIUSProxyApiExample {
    public static void main(String[] args) {
        RADIUSProxyApi apiInstance = new RADIUSProxyApi();

        try {
            apiInstance.deleteRadiusProxyConfig();
        } catch (ApiException e) {
            System.err.println("Exception when calling RADIUSProxyApi#deleteRadiusProxyConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RADIUSProxyApi *apiInstance = [[RADIUSProxyApi alloc] init];

// Delete RADIUS Proxy configuration.
[apiInstance deleteRadiusProxyConfigWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.RADIUSProxyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRadiusProxyConfig(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteRadiusProxyConfigExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RADIUSProxyApi();

            try {
                // Delete RADIUS Proxy configuration.
                apiInstance.deleteRadiusProxyConfig();
            } catch (Exception e) {
                Debug.Print("Exception when calling RADIUSProxyApi.deleteRadiusProxyConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RADIUSProxyApi();

try {
    $api_instance->deleteRadiusProxyConfig();
} catch (Exception $e) {
    echo 'Exception when calling RADIUSProxyApi->deleteRadiusProxyConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RADIUSProxyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RADIUSProxyApi->new();

eval {
    $api_instance->deleteRadiusProxyConfig();
};
if ($@) {
    warn "Exception when calling RADIUSProxyApi->deleteRadiusProxyConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RADIUSProxyApi()

try:
    # Delete RADIUS Proxy configuration.
    api_instance.delete_radius_proxy_config()
except ApiException as e:
    print("Exception when calling RADIUSProxyApi->deleteRadiusProxyConfig: %s\n" % e)
extern crate RADIUSProxyApi;

pub fn main() {

    let mut context = RADIUSProxyApi::Context::default();
    let result = client.deleteRadiusProxyConfig(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

getRadiusProxyConfig

Retrieve RADIUS Proxy configuration.


/radiusProxyConfig

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/radiusProxyConfig"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RADIUSProxyApi;

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

public class RADIUSProxyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RADIUSProxyApi apiInstance = new RADIUSProxyApi();

        try {
            apiInstance.getRadiusProxyConfig();
        } catch (ApiException e) {
            System.err.println("Exception when calling RADIUSProxyApi#getRadiusProxyConfig");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.RADIUSProxyApi;

public class RADIUSProxyApiExample {
    public static void main(String[] args) {
        RADIUSProxyApi apiInstance = new RADIUSProxyApi();

        try {
            apiInstance.getRadiusProxyConfig();
        } catch (ApiException e) {
            System.err.println("Exception when calling RADIUSProxyApi#getRadiusProxyConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RADIUSProxyApi *apiInstance = [[RADIUSProxyApi alloc] init];

// Retrieve RADIUS Proxy configuration.
[apiInstance getRadiusProxyConfigWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.RADIUSProxyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getRadiusProxyConfig(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRadiusProxyConfigExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RADIUSProxyApi();

            try {
                // Retrieve RADIUS Proxy configuration.
                apiInstance.getRadiusProxyConfig();
            } catch (Exception e) {
                Debug.Print("Exception when calling RADIUSProxyApi.getRadiusProxyConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RADIUSProxyApi();

try {
    $api_instance->getRadiusProxyConfig();
} catch (Exception $e) {
    echo 'Exception when calling RADIUSProxyApi->getRadiusProxyConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RADIUSProxyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RADIUSProxyApi->new();

eval {
    $api_instance->getRadiusProxyConfig();
};
if ($@) {
    warn "Exception when calling RADIUSProxyApi->getRadiusProxyConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RADIUSProxyApi()

try:
    # Retrieve RADIUS Proxy configuration.
    api_instance.get_radius_proxy_config()
except ApiException as e:
    print("Exception when calling RADIUSProxyApi->getRadiusProxyConfig: %s\n" % e)
extern crate RADIUSProxyApi;

pub fn main() {

    let mut context = RADIUSProxyApi::Context::default();
    let result = client.getRadiusProxyConfig(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

modifyRadiusProxyConfig

Modify RADIUS Proxy configuration.


/radiusProxyConfig

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/radiusProxyConfig" \
 -d '{
  "pools" : [ {
    "radsecPoolType" : "generic",
    "acctConfig" : {
      "monitorMethod" : "none",
      "servers" : [ {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      }, {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      } ],
      "methodParameters" : [ "methodParameters", "methodParameters" ],
      "monitor" : false,
      "strategy" : "random"
    },
    "authConfig" : {
      "monitorMethod" : "none",
      "servers" : [ {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      }, {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      } ],
      "methodParameters" : [ "methodParameters", "methodParameters" ],
      "monitor" : false,
      "strategy" : "random"
    },
    "name" : "name",
    "description" : "description",
    "poolProxyIp" : "[\"These addresses must match the addresses in the AP configuration and must start with 0.0\",\"0.0.0.1\",\"0.0.1.1\"]",
    "radsecPoolKeepAlive" : 5,
    "coaConfig" : {
      "monitorMethod" : "none",
      "servers" : [ {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      }, {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      } ],
      "methodParameters" : [ "methodParameters", "methodParameters" ],
      "monitor" : false,
      "strategy" : "random"
    },
    "enabled" : true
  }, {
    "radsecPoolType" : "generic",
    "acctConfig" : {
      "monitorMethod" : "none",
      "servers" : [ {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      }, {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      } ],
      "methodParameters" : [ "methodParameters", "methodParameters" ],
      "monitor" : false,
      "strategy" : "random"
    },
    "authConfig" : {
      "monitorMethod" : "none",
      "servers" : [ {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      }, {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      } ],
      "methodParameters" : [ "methodParameters", "methodParameters" ],
      "monitor" : false,
      "strategy" : "random"
    },
    "name" : "name",
    "description" : "description",
    "poolProxyIp" : "[\"These addresses must match the addresses in the AP configuration and must start with 0.0\",\"0.0.0.1\",\"0.0.1.1\"]",
    "radsecPoolKeepAlive" : 5,
    "coaConfig" : {
      "monitorMethod" : "none",
      "servers" : [ {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      }, {
        "ip" : "ip",
        "certificate" : "certificate",
        "weight" : 6,
        "radsecPort" : 9607,
        "secret" : "secret",
        "radsecCacerts" : [ "radsecCacerts", "radsecCacerts" ],
        "radsecCert" : "radsecCert",
        "radsec" : false,
        "port" : 0,
        "radsecKey" : "radsecKey",
        "name" : "name",
        "ignore" : false,
        "radsecRealms" : [ "radsecRealms", "radsecRealms" ],
        "radsecSecret" : "radsecSecret"
      } ],
      "methodParameters" : [ "methodParameters", "methodParameters" ],
      "monitor" : false,
      "strategy" : "random"
    },
    "enabled" : true
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RADIUSProxyApi;

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

public class RADIUSProxyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RADIUSProxyApi apiInstance = new RADIUSProxyApi();
        RadiusProxyPoolList radiusProxyPoolList = ; // RadiusProxyPoolList | 

        try {
            apiInstance.modifyRadiusProxyConfig(radiusProxyPoolList);
        } catch (ApiException e) {
            System.err.println("Exception when calling RADIUSProxyApi#modifyRadiusProxyConfig");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.RADIUSProxyApi;

public class RADIUSProxyApiExample {
    public static void main(String[] args) {
        RADIUSProxyApi apiInstance = new RADIUSProxyApi();
        RadiusProxyPoolList radiusProxyPoolList = ; // RadiusProxyPoolList | 

        try {
            apiInstance.modifyRadiusProxyConfig(radiusProxyPoolList);
        } catch (ApiException e) {
            System.err.println("Exception when calling RADIUSProxyApi#modifyRadiusProxyConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RADIUSProxyApi *apiInstance = [[RADIUSProxyApi alloc] init];
RadiusProxyPoolList *radiusProxyPoolList = ; //  (optional)

// Modify RADIUS Proxy configuration.
[apiInstance modifyRadiusProxyConfigWith:radiusProxyPoolList
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.RADIUSProxyApi()
var opts = {
  'radiusProxyPoolList':  // {RadiusProxyPoolList} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyRadiusProxyConfig(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyRadiusProxyConfigExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RADIUSProxyApi();
            var radiusProxyPoolList = new RadiusProxyPoolList(); // RadiusProxyPoolList |  (optional) 

            try {
                // Modify RADIUS Proxy configuration.
                apiInstance.modifyRadiusProxyConfig(radiusProxyPoolList);
            } catch (Exception e) {
                Debug.Print("Exception when calling RADIUSProxyApi.modifyRadiusProxyConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RADIUSProxyApi();
$radiusProxyPoolList = ; // RadiusProxyPoolList | 

try {
    $api_instance->modifyRadiusProxyConfig($radiusProxyPoolList);
} catch (Exception $e) {
    echo 'Exception when calling RADIUSProxyApi->modifyRadiusProxyConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RADIUSProxyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RADIUSProxyApi->new();
my $radiusProxyPoolList = WWW::OPenAPIClient::Object::RadiusProxyPoolList->new(); # RadiusProxyPoolList | 

eval {
    $api_instance->modifyRadiusProxyConfig(radiusProxyPoolList => $radiusProxyPoolList);
};
if ($@) {
    warn "Exception when calling RADIUSProxyApi->modifyRadiusProxyConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RADIUSProxyApi()
radiusProxyPoolList =  # RadiusProxyPoolList |  (optional)

try:
    # Modify RADIUS Proxy configuration.
    api_instance.modify_radius_proxy_config(radiusProxyPoolList=radiusProxyPoolList)
except ApiException as e:
    print("Exception when calling RADIUSProxyApi->modifyRadiusProxyConfig: %s\n" % e)
extern crate RADIUSProxyApi;

pub fn main() {
    let radiusProxyPoolList = ; // RadiusProxyPoolList

    let mut context = RADIUSProxyApi::Context::default();
    let result = client.modifyRadiusProxyConfig(radiusProxyPoolList, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
radiusProxyPoolList

Change RADIUS configuration pool config

Responses

RadiusSessions

getAPRadiusSessions

Retrieve the RADIUS sessions for a given AP


/radiusSessions/{serialNumber}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/radiusSessions/{serialNumber}?serialNumberOnly=true&userName=userName_example&mac=aa:bb:cc:dd:ee:ff"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RadiusSessionsApi;

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

public class RadiusSessionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RadiusSessionsApi apiInstance = new RadiusSessionsApi();
        String serialNumber = for searches or listing only serial number, set the serialNumber to 0; // String | 
        Boolean serialNumberOnly = true; // Boolean | 
        String userName = userName_example; // String | 
        String mac = aa:bb:cc:dd:ee:ff; // String | 

        try {
            getAPRadiusSessions_200_response result = apiInstance.getAPRadiusSessions(serialNumber, serialNumberOnly, userName, mac);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RadiusSessionsApi#getAPRadiusSessions");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.RadiusSessionsApi;

public class RadiusSessionsApiExample {
    public static void main(String[] args) {
        RadiusSessionsApi apiInstance = new RadiusSessionsApi();
        String serialNumber = for searches or listing only serial number, set the serialNumber to 0; // String | 
        Boolean serialNumberOnly = true; // Boolean | 
        String userName = userName_example; // String | 
        String mac = aa:bb:cc:dd:ee:ff; // String | 

        try {
            getAPRadiusSessions_200_response result = apiInstance.getAPRadiusSessions(serialNumber, serialNumberOnly, userName, mac);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RadiusSessionsApi#getAPRadiusSessions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RadiusSessionsApi *apiInstance = [[RadiusSessionsApi alloc] init];
String *serialNumber = for searches or listing only serial number, set the serialNumber to 0; //  (default to null)
Boolean *serialNumberOnly = true; //  (optional) (default to null)
String *userName = userName_example; //  (optional) (default to null)
String *mac = aa:bb:cc:dd:ee:ff; //  (optional) (default to null)

// Retrieve the RADIUS sessions for a given AP
[apiInstance getAPRadiusSessionsWith:serialNumber
    serialNumberOnly:serialNumberOnly
    userName:userName
    mac:mac
              completionHandler: ^(getAPRadiusSessions_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.RadiusSessionsApi()
var serialNumber = for searches or listing only serial number, set the serialNumber to 0; // {String} 
var opts = {
  'serialNumberOnly': true, // {Boolean} 
  'userName': userName_example, // {String} 
  'mac': aa:bb:cc:dd:ee:ff // {String} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAPRadiusSessionsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RadiusSessionsApi();
            var serialNumber = for searches or listing only serial number, set the serialNumber to 0;  // String |  (default to null)
            var serialNumberOnly = true;  // Boolean |  (optional)  (default to null)
            var userName = userName_example;  // String |  (optional)  (default to null)
            var mac = aa:bb:cc:dd:ee:ff;  // String |  (optional)  (default to null)

            try {
                // Retrieve the RADIUS sessions for a given AP
                getAPRadiusSessions_200_response result = apiInstance.getAPRadiusSessions(serialNumber, serialNumberOnly, userName, mac);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RadiusSessionsApi.getAPRadiusSessions: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RadiusSessionsApi();
$serialNumber = for searches or listing only serial number, set the serialNumber to 0; // String | 
$serialNumberOnly = true; // Boolean | 
$userName = userName_example; // String | 
$mac = aa:bb:cc:dd:ee:ff; // String | 

try {
    $result = $api_instance->getAPRadiusSessions($serialNumber, $serialNumberOnly, $userName, $mac);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RadiusSessionsApi->getAPRadiusSessions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RadiusSessionsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RadiusSessionsApi->new();
my $serialNumber = for searches or listing only serial number, set the serialNumber to 0; # String | 
my $serialNumberOnly = true; # Boolean | 
my $userName = userName_example; # String | 
my $mac = aa:bb:cc:dd:ee:ff; # String | 

eval {
    my $result = $api_instance->getAPRadiusSessions(serialNumber => $serialNumber, serialNumberOnly => $serialNumberOnly, userName => $userName, mac => $mac);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RadiusSessionsApi->getAPRadiusSessions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RadiusSessionsApi()
serialNumber = for searches or listing only serial number, set the serialNumber to 0 # String |  (default to null)
serialNumberOnly = true # Boolean |  (optional) (default to null)
userName = userName_example # String |  (optional) (default to null)
mac = aa:bb:cc:dd:ee:ff # String |  (optional) (default to null)

try:
    # Retrieve the RADIUS sessions for a given AP
    api_response = api_instance.get_ap_radius_sessions(serialNumber, serialNumberOnly=serialNumberOnly, userName=userName, mac=mac)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RadiusSessionsApi->getAPRadiusSessions: %s\n" % e)
extern crate RadiusSessionsApi;

pub fn main() {
    let serialNumber = for searches or listing only serial number, set the serialNumber to 0; // String
    let serialNumberOnly = true; // Boolean
    let userName = userName_example; // String
    let mac = aa:bb:cc:dd:ee:ff; // String

    let mut context = RadiusSessionsApi::Context::default();
    let result = client.getAPRadiusSessions(serialNumber, serialNumberOnly, userName, mac, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
serialNumberOnly
Boolean
userName
String
mac
String

Responses

putAPRadiusSessions

Retrieve the RADIUS sessions for a given AP


/radiusSessions/{serialNumber}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/radiusSessions/{serialNumber}?operation=operation_example" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RadiusSessionsApi;

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

public class RadiusSessionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RadiusSessionsApi apiInstance = new RadiusSessionsApi();
        String serialNumber = serialNumber_example; // String | 
        String operation = operation_example; // String | 
        PutAPRadiusSessionsRequest putAPRadiusSessionsRequest = ; // PutAPRadiusSessionsRequest | 

        try {
            apiInstance.putAPRadiusSessions(serialNumber, operation, putAPRadiusSessionsRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RadiusSessionsApi#putAPRadiusSessions");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.RadiusSessionsApi;

public class RadiusSessionsApiExample {
    public static void main(String[] args) {
        RadiusSessionsApi apiInstance = new RadiusSessionsApi();
        String serialNumber = serialNumber_example; // String | 
        String operation = operation_example; // String | 
        PutAPRadiusSessionsRequest putAPRadiusSessionsRequest = ; // PutAPRadiusSessionsRequest | 

        try {
            apiInstance.putAPRadiusSessions(serialNumber, operation, putAPRadiusSessionsRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling RadiusSessionsApi#putAPRadiusSessions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RadiusSessionsApi *apiInstance = [[RadiusSessionsApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
String *operation = operation_example; //  (optional) (default to null)
PutAPRadiusSessionsRequest *putAPRadiusSessionsRequest = ; //  (optional)

// Retrieve the RADIUS sessions for a given AP
[apiInstance putAPRadiusSessionsWith:serialNumber
    operation:operation
    putAPRadiusSessionsRequest:putAPRadiusSessionsRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.RadiusSessionsApi()
var serialNumber = serialNumber_example; // {String} 
var opts = {
  'operation': operation_example, // {String} 
  'putAPRadiusSessionsRequest':  // {PutAPRadiusSessionsRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putAPRadiusSessions(serialNumber, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putAPRadiusSessionsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RadiusSessionsApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var operation = operation_example;  // String |  (optional)  (default to null)
            var putAPRadiusSessionsRequest = new PutAPRadiusSessionsRequest(); // PutAPRadiusSessionsRequest |  (optional) 

            try {
                // Retrieve the RADIUS sessions for a given AP
                apiInstance.putAPRadiusSessions(serialNumber, operation, putAPRadiusSessionsRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling RadiusSessionsApi.putAPRadiusSessions: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RadiusSessionsApi();
$serialNumber = serialNumber_example; // String | 
$operation = operation_example; // String | 
$putAPRadiusSessionsRequest = ; // PutAPRadiusSessionsRequest | 

try {
    $api_instance->putAPRadiusSessions($serialNumber, $operation, $putAPRadiusSessionsRequest);
} catch (Exception $e) {
    echo 'Exception when calling RadiusSessionsApi->putAPRadiusSessions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RadiusSessionsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RadiusSessionsApi->new();
my $serialNumber = serialNumber_example; # String | 
my $operation = operation_example; # String | 
my $putAPRadiusSessionsRequest = WWW::OPenAPIClient::Object::PutAPRadiusSessionsRequest->new(); # PutAPRadiusSessionsRequest | 

eval {
    $api_instance->putAPRadiusSessions(serialNumber => $serialNumber, operation => $operation, putAPRadiusSessionsRequest => $putAPRadiusSessionsRequest);
};
if ($@) {
    warn "Exception when calling RadiusSessionsApi->putAPRadiusSessions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RadiusSessionsApi()
serialNumber = serialNumber_example # String |  (default to null)
operation = operation_example # String |  (optional) (default to null)
putAPRadiusSessionsRequest =  # PutAPRadiusSessionsRequest |  (optional)

try:
    # Retrieve the RADIUS sessions for a given AP
    api_instance.put_ap_radius_sessions(serialNumber, operation=operation, putAPRadiusSessionsRequest=putAPRadiusSessionsRequest)
except ApiException as e:
    print("Exception when calling RadiusSessionsApi->putAPRadiusSessions: %s\n" % e)
extern crate RadiusSessionsApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let operation = operation_example; // String
    let putAPRadiusSessionsRequest = ; // PutAPRadiusSessionsRequest

    let mut context = RadiusSessionsApi::Context::default();
    let result = client.putAPRadiusSessions(serialNumber, operation, putAPRadiusSessionsRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
putAPRadiusSessionsRequest

operationParameters
Query parameters
Name Description
operation
String

Responses

Scripting

createScript

Create a new script.


/script/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/script/{uuid}" \
 -d '{
  "deferred" : false,
  "defaultUploadURI" : "defaultUploadURI",
  "created" : 0,
  "author" : "author",
  "description" : "description",
  "type" : "shell",
  "uri" : "uri",
  "version" : "version",
  "content" : "content",
  "timeout" : 1,
  "restricted" : [ "restricted", "restricted" ],
  "name" : "name",
  "modified" : 6,
  "id" : "id"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ScriptingApi;

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

public class ScriptingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script. Must be set to 0 for creation
        ScriptEntry scriptEntry = ; // ScriptEntry | 

        try {
            apiInstance.createScript(uuid, scriptEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#createScript");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ScriptingApi;

public class ScriptingApiExample {
    public static void main(String[] args) {
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script. Must be set to 0 for creation
        ScriptEntry scriptEntry = ; // ScriptEntry | 

        try {
            apiInstance.createScript(uuid, scriptEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#createScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ScriptingApi *apiInstance = [[ScriptingApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of the script. Must be set to 0 for creation (default to null)
ScriptEntry *scriptEntry = ; //  (optional)

// Create a new script.
[apiInstance createScriptWith:uuid
    scriptEntry:scriptEntry
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ScriptingApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The UUID of the script. Must be set to 0 for creation
var opts = {
  'scriptEntry':  // {ScriptEntry} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createScript(uuid, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createScriptExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ScriptingApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The UUID of the script. Must be set to 0 for creation (default to null)
            var scriptEntry = new ScriptEntry(); // ScriptEntry |  (optional) 

            try {
                // Create a new script.
                apiInstance.createScript(uuid, scriptEntry);
            } catch (Exception e) {
                Debug.Print("Exception when calling ScriptingApi.createScript: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ScriptingApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script. Must be set to 0 for creation
$scriptEntry = ; // ScriptEntry | 

try {
    $api_instance->createScript($uuid, $scriptEntry);
} catch (Exception $e) {
    echo 'Exception when calling ScriptingApi->createScript: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ScriptingApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ScriptingApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of the script. Must be set to 0 for creation
my $scriptEntry = WWW::OPenAPIClient::Object::ScriptEntry->new(); # ScriptEntry | 

eval {
    $api_instance->createScript(uuid => $uuid, scriptEntry => $scriptEntry);
};
if ($@) {
    warn "Exception when calling ScriptingApi->createScript: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ScriptingApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of the script. Must be set to 0 for creation (default to null)
scriptEntry =  # ScriptEntry |  (optional)

try:
    # Create a new script.
    api_instance.create_script(uuid, scriptEntry=scriptEntry)
except ApiException as e:
    print("Exception when calling ScriptingApi->createScript: %s\n" % e)
extern crate ScriptingApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let scriptEntry = ; // ScriptEntry

    let mut context = ScriptingApi::Context::default();
    let result = client.createScript(uuid, scriptEntry, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
The UUID of the script. Must be set to 0 for creation
Required
Body parameters
Name Description
scriptEntry

Complet script entry

Responses

deleteScript

Delete a script.


/script/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/script/{uuid}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ScriptingApi;

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

public class ScriptingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.deleteScript(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#deleteScript");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ScriptingApi;

public class ScriptingApiExample {
    public static void main(String[] args) {
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.deleteScript(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#deleteScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ScriptingApi *apiInstance = [[ScriptingApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a script.
[apiInstance deleteScriptWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ScriptingApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteScript(uuid, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteScriptExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ScriptingApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a script.
                apiInstance.deleteScript(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling ScriptingApi.deleteScript: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ScriptingApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->deleteScript($uuid);
} catch (Exception $e) {
    echo 'Exception when calling ScriptingApi->deleteScript: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ScriptingApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ScriptingApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteScript(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling ScriptingApi->deleteScript: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ScriptingApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a script.
    api_instance.delete_script(uuid)
except ApiException as e:
    print("Exception when calling ScriptingApi->deleteScript: %s\n" % e)
extern crate ScriptingApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ScriptingApi::Context::default();
    let result = client.deleteScript(uuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses

getScript

Returns a script entry.

Get a specific script entry.


/script/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/script/{uuid}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ScriptingApi;

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

public class ScriptingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script

        try {
            ScriptEntry result = apiInstance.getScript(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#getScript");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ScriptingApi;

public class ScriptingApiExample {
    public static void main(String[] args) {
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script

        try {
            ScriptEntry result = apiInstance.getScript(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#getScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ScriptingApi *apiInstance = [[ScriptingApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of the script (default to null)

// Returns a script entry.
[apiInstance getScriptWith:uuid
              completionHandler: ^(ScriptEntry output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ScriptingApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The UUID of the script

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getScriptExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ScriptingApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The UUID of the script (default to null)

            try {
                // Returns a script entry.
                ScriptEntry result = apiInstance.getScript(uuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ScriptingApi.getScript: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ScriptingApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ScriptingApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of the script

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ScriptingApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of the script (default to null)

try:
    # Returns a script entry.
    api_response = api_instance.get_script(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScriptingApi->getScript: %s\n" % e)
extern crate ScriptingApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ScriptingApi::Context::default();
    let result = client.getScript(uuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
The UUID of the script
Required

Responses

getScripts

Returns a list scripts.

Get a list of scripts.


/scripts

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/scripts?offset=56&limit=56&filter=filter_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ScriptingApi;

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

public class ScriptingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ScriptingApi apiInstance = new ScriptingApi();
        Integer offset = 56; // Integer | Pagination start (starts at 0. If not specified, 0 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results

        try {
            ScriptEntryList result = apiInstance.getScripts(offset, limit, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#getScripts");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ScriptingApi;

public class ScriptingApiExample {
    public static void main(String[] args) {
        ScriptingApi apiInstance = new ScriptingApi();
        Integer offset = 56; // Integer | Pagination start (starts at 0. If not specified, 0 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results

        try {
            ScriptEntryList result = apiInstance.getScripts(offset, limit, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#getScripts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ScriptingApi *apiInstance = [[ScriptingApi alloc] init];
Integer *offset = 56; // Pagination start (starts at 0. If not specified, 0 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *filter = filter_example; // Filter the results (optional) (default to null)

// Returns a list scripts.
[apiInstance getScriptsWith:offset
    limit:limit
    filter:filter
              completionHandler: ^(ScriptEntryList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ScriptingApi()
var opts = {
  'offset': 56, // {Integer} Pagination start (starts at 0. If not specified, 0 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'filter': filter_example // {String} Filter the results
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getScriptsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ScriptingApi();
            var offset = 56;  // Integer | Pagination start (starts at 0. If not specified, 0 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var filter = filter_example;  // String | Filter the results (optional)  (default to null)

            try {
                // Returns a list scripts.
                ScriptEntryList result = apiInstance.getScripts(offset, limit, filter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ScriptingApi.getScripts: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ScriptingApi();
$offset = 56; // Integer | Pagination start (starts at 0. If not specified, 0 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$filter = filter_example; // String | Filter the results

try {
    $result = $api_instance->getScripts($offset, $limit, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScriptingApi->getScripts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ScriptingApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ScriptingApi->new();
my $offset = 56; # Integer | Pagination start (starts at 0. If not specified, 0 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $filter = filter_example; # String | Filter the results

eval {
    my $result = $api_instance->getScripts(offset => $offset, limit => $limit, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScriptingApi->getScripts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ScriptingApi()
offset = 56 # Integer | Pagination start (starts at 0. If not specified, 0 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
filter = filter_example # String | Filter the results (optional) (default to null)

try:
    # Returns a list scripts.
    api_response = api_instance.get_scripts(offset=offset, limit=limit, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScriptingApi->getScripts: %s\n" % e)
extern crate ScriptingApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String

    let mut context = ScriptingApi::Context::default();
    let result = client.getScripts(offset, limit, filter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Pagination start (starts at 0. If not specified, 0 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
filter
String
Filter the results

Responses

modifyScript

Modify a script.


/script/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/script/{uuid}" \
 -d '{
  "deferred" : false,
  "defaultUploadURI" : "defaultUploadURI",
  "created" : 0,
  "author" : "author",
  "description" : "description",
  "type" : "shell",
  "uri" : "uri",
  "version" : "version",
  "content" : "content",
  "timeout" : 1,
  "restricted" : [ "restricted", "restricted" ],
  "name" : "name",
  "modified" : 6,
  "id" : "id"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ScriptingApi;

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

public class ScriptingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script.
        ScriptEntry scriptEntry = ; // ScriptEntry | 

        try {
            apiInstance.modifyScript(uuid, scriptEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#modifyScript");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ScriptingApi;

public class ScriptingApiExample {
    public static void main(String[] args) {
        ScriptingApi apiInstance = new ScriptingApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script.
        ScriptEntry scriptEntry = ; // ScriptEntry | 

        try {
            apiInstance.modifyScript(uuid, scriptEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScriptingApi#modifyScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ScriptingApi *apiInstance = [[ScriptingApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The UUID of the script. (default to null)
ScriptEntry *scriptEntry = ; //  (optional)

// Modify a script.
[apiInstance modifyScriptWith:uuid
    scriptEntry:scriptEntry
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.ScriptingApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The UUID of the script.
var opts = {
  'scriptEntry':  // {ScriptEntry} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyScript(uuid, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyScriptExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ScriptingApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The UUID of the script. (default to null)
            var scriptEntry = new ScriptEntry(); // ScriptEntry |  (optional) 

            try {
                // Modify a script.
                apiInstance.modifyScript(uuid, scriptEntry);
            } catch (Exception e) {
                Debug.Print("Exception when calling ScriptingApi.modifyScript: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ScriptingApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The UUID of the script.
$scriptEntry = ; // ScriptEntry | 

try {
    $api_instance->modifyScript($uuid, $scriptEntry);
} catch (Exception $e) {
    echo 'Exception when calling ScriptingApi->modifyScript: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ScriptingApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ScriptingApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The UUID of the script.
my $scriptEntry = WWW::OPenAPIClient::Object::ScriptEntry->new(); # ScriptEntry | 

eval {
    $api_instance->modifyScript(uuid => $uuid, scriptEntry => $scriptEntry);
};
if ($@) {
    warn "Exception when calling ScriptingApi->modifyScript: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ScriptingApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The UUID of the script. (default to null)
scriptEntry =  # ScriptEntry |  (optional)

try:
    # Modify a script.
    api_instance.modify_script(uuid, scriptEntry=scriptEntry)
except ApiException as e:
    print("Exception when calling ScriptingApi->modifyScript: %s\n" % e)
extern crate ScriptingApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let scriptEntry = ; // ScriptEntry

    let mut context = ScriptingApi::Context::default();
    let result = client.modifyScript(uuid, scriptEntry, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
The UUID of the script.
Required
Body parameters
Name Description
scriptEntry

Complete script entry. You may only modify the name, description, version, uri, and content

Responses

SystemCommands

getSystemCommand

Retrieve different values from the running service.


/system

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/system?command=command_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

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

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            apiInstance.getSystemCommand(command);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            apiInstance.getSystemCommand(command);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
String *command = command_example; // Get a value (default to null)

// Retrieve different values from the running service.
[apiInstance getSystemCommandWith:command
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.SystemCommandsApi()
var command = command_example; // {String} Get a value

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSystemCommand(command, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var command = command_example;  // String | Get a value (default to null)

            try {
                // Retrieve different values from the running service.
                apiInstance.getSystemCommand(command);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$command = command_example; // String | Get a value

try {
    $api_instance->getSystemCommand($command);
} catch (Exception $e) {
    echo 'Exception when calling SystemCommandsApi->getSystemCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemCommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $command = command_example; # String | Get a value

eval {
    $api_instance->getSystemCommand(command => $command);
};
if ($@) {
    warn "Exception when calling SystemCommandsApi->getSystemCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
command = command_example # String | Get a value (default to null)

try:
    # Retrieve different values from the running service.
    api_instance.get_system_command(command)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let command = command_example; // String

    let mut context = SystemCommandsApi::Context::default();
    let result = client.getSystemCommand(command, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
command*
String
Get a value
Required

Responses

systemCommand

Perform some system wide commands.


/system

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/system" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

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

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
SystemCommandRequest *systemCommandRequest = ; //  (optional)

// Perform some system wide commands.
[apiInstance systemCommandWith:systemCommandRequest
              completionHandler: ^(systemCommand_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.SystemCommandsApi()
var opts = {
  'systemCommandRequest':  // {SystemCommandRequest} 
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class systemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var systemCommandRequest = new SystemCommandRequest(); // SystemCommandRequest |  (optional) 

            try {
                // Perform some system wide commands.
                systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.systemCommand: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$systemCommandRequest = ; // SystemCommandRequest | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $systemCommandRequest = WWW::OPenAPIClient::Object::SystemCommandRequest->new(); # SystemCommandRequest | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
systemCommandRequest =  # SystemCommandRequest |  (optional)

try:
    # Perform some system wide commands.
    api_response = api_instance.system_command(systemCommandRequest=systemCommandRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->systemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let systemCommandRequest = ; // SystemCommandRequest

    let mut context = SystemCommandsApi::Context::default();
    let result = client.systemCommand(systemCommandRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
systemCommandRequest

Command details

Responses

SystemConfiguration

deleteSystemConfiguration

Delete all additional system configuration


/systemConfiguration

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16002/api/v1/systemConfiguration"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

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

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();

        try {
            apiInstance.deleteSystemConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#deleteSystemConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();

        try {
            apiInstance.deleteSystemConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#deleteSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];

// Delete all additional system configuration
[apiInstance deleteSystemConfigurationWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.SystemConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSystemConfiguration(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();

            try {
                // Delete all additional system configuration
                apiInstance.deleteSystemConfiguration();
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.deleteSystemConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();

try {
    $api_instance->deleteSystemConfiguration();
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->deleteSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();

eval {
    $api_instance->deleteSystemConfiguration();
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->deleteSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()

try:
    # Delete all additional system configuration
    api_instance.delete_system_configuration()
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->deleteSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.deleteSystemConfiguration(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

getSystemConfiguration

Retrieve system configuration items


/systemConfiguration

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/systemConfiguration?entries=["element1","element1,element2,element3"]"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

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

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        String entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

        try {
            array[List] result = apiInstance.getSystemConfiguration(entries);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#getSystemConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        String entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

        try {
            array[List] result = apiInstance.getSystemConfiguration(entries);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#getSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];
String *entries = ["element1","element1,element2,element3"]; // Which parameters you want to retrieve (optional) (default to null)

// Retrieve system configuration items
[apiInstance getSystemConfigurationWith:entries
              completionHandler: ^(array[List] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.SystemConfigurationApi()
var opts = {
  'entries': ["element1","element1,element2,element3"] // {String} Which parameters you want to retrieve
};

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();
            var entries = ["element1","element1,element2,element3"];  // String | Which parameters you want to retrieve (optional)  (default to null)

            try {
                // Retrieve system configuration items
                array[List] result = apiInstance.getSystemConfiguration(entries);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.getSystemConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();
$entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();
my $entries = ["element1","element1,element2,element3"]; # String | Which parameters you want to retrieve

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()
entries = ["element1","element1,element2,element3"] # String | Which parameters you want to retrieve (optional) (default to null)

try:
    # Retrieve system configuration items
    api_response = api_instance.get_system_configuration(entries=entries)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->getSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {
    let entries = ["element1","element1,element2,element3"]; // String

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.getSystemConfiguration(entries, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
entries
String
Which parameters you want to retrieve

Responses

setSystemConfiguration

Set some or all system configuration


/systemConfiguration

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16002/api/v1/systemConfiguration" \
 -d '{
  "parameterName" : "parameterName",
  "parameterValue" : "parameterValue"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

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

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        array[ExtraSystemConfiguration_inner] extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

        try {
            apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#setSystemConfiguration");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        array[ExtraSystemConfiguration_inner] extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

        try {
            apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#setSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];
array[ExtraSystemConfiguration_inner] *extraSystemConfigurationInner = ; //  (optional)

// Set some or all system configuration
[apiInstance setSystemConfigurationWith:extraSystemConfigurationInner
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.SystemConfigurationApi()
var opts = {
  'extraSystemConfigurationInner':  // {array[ExtraSystemConfiguration_inner]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setSystemConfiguration(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();
            var extraSystemConfigurationInner = new array[ExtraSystemConfiguration_inner](); // array[ExtraSystemConfiguration_inner] |  (optional) 

            try {
                // Set some or all system configuration
                apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.setSystemConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();
$extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

try {
    $api_instance->setSystemConfiguration($extraSystemConfigurationInner);
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->setSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();
my $extraSystemConfigurationInner = [WWW::OPenAPIClient::Object::array[ExtraSystemConfiguration_inner]->new()]; # array[ExtraSystemConfiguration_inner] | 

eval {
    $api_instance->setSystemConfiguration(extraSystemConfigurationInner => $extraSystemConfigurationInner);
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->setSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()
extraSystemConfigurationInner =  # array[ExtraSystemConfiguration_inner] |  (optional)

try:
    # Set some or all system configuration
    api_instance.set_system_configuration(extraSystemConfigurationInner=extraSystemConfigurationInner)
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->setSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {
    let extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner]

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.setSystemConfiguration(extraSystemConfigurationInner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
extraSystemConfigurationInner

Responses

Utility

getIpToCountry

Get the country code for an IP address


/iptocountry

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16002/api/v1/iptocountry?iplist=10.2.2.2,10.3.4.3"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UtilityApi;

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

public class UtilityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UtilityApi apiInstance = new UtilityApi();
        String iplist = 10.2.2.2,10.3.4.3; // String | 

        try {
            getIpToCountry_200_response result = apiInstance.getIpToCountry(iplist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UtilityApi#getIpToCountry");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.UtilityApi;

public class UtilityApiExample {
    public static void main(String[] args) {
        UtilityApi apiInstance = new UtilityApi();
        String iplist = 10.2.2.2,10.3.4.3; // String | 

        try {
            getIpToCountry_200_response result = apiInstance.getIpToCountry(iplist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UtilityApi#getIpToCountry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UtilityApi *apiInstance = [[UtilityApi alloc] init];
String *iplist = 10.2.2.2,10.3.4.3; //  (default to null)

// Get the country code for an IP address
[apiInstance getIpToCountryWith:iplist
              completionHandler: ^(getIpToCountry_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var UCentralGatewayApi = require('u_central_gateway_api');
var defaultClient = UCentralGatewayApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralGatewayApi.UtilityApi()
var iplist = 10.2.2.2,10.3.4.3; // {String} 

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

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getIpToCountryExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UtilityApi();
            var iplist = 10.2.2.2,10.3.4.3;  // String |  (default to null)

            try {
                // Get the country code for an IP address
                getIpToCountry_200_response result = apiInstance.getIpToCountry(iplist);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UtilityApi.getIpToCountry: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UtilityApi();
$iplist = 10.2.2.2,10.3.4.3; // String | 

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

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UtilityApi->new();
my $iplist = 10.2.2.2,10.3.4.3; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UtilityApi()
iplist = 10.2.2.2,10.3.4.3 # String |  (default to null)

try:
    # Get the country code for an IP address
    api_response = api_instance.get_ip_to_country(iplist)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UtilityApi->getIpToCountry: %s\n" % e)
extern crate UtilityApi;

pub fn main() {
    let iplist = 10.2.2.2,10.3.4.3; // String

    let mut context = UtilityApi::Context::default();
    let result = client.getIpToCountry(iplist, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
iplist*
String
Required

Responses