skip to Main Content

REST API and the SDK Package in NoTouch Center 4.5 “Emerald Bay”

Rest API and the SDK Package Blog

The one feature that got my heart beating faster in the recent release of NoTouch Center was by far the SDK Package, with its ability to perform REST API calls. As the trends in IT are going towards building infrastructure with code and scripting administrative tasks instead of using the GUI, this is demonstrating that we are carefully following the industry demands to make sure our much praised management solution stays current.

How to get started

What you will need is

  1. NoTouch Center version 4.5.x or greater
  2. An API Account in NoTouch Center
  3. An environment where you can execute Python, Java, Bash or PowerShell -scripts

Getting the SDK kit from NoTouch Center

Log in to your NoTouch Console and on the top click Resources click and then About. Scroll down almost to the end, until  you reach the Extensions section.

Click on the NoTouch Center SDK Package -link to download the SDK package to your computer.

Unpack the content to a directory and you will see the following: 

Under services you will find example code on how to create custom plugins to NoTouch Center. The api folder contains examples for REST API commands in bash, JavaScript, Python and Powershell, which we will focus on in this tech-note.

Creating an Account for the API calls

In order to perform REST API calls you would need to have an account who has the rights to execute the commands requested on NoTouch Center. In addition that account needs to have the “Login via API” right.

Before you create a user account, you should create a role with the appropriate rights. Create a new role and give it suitable permissions that match what you need to perform the actions you want to complete through the REST API calls. For testing purposes, you could select the Expert template, but for production you should go with the absolute minimum rights.

Once done, search for API to make sure that Login/Via API is enabled, and click Save.

Now you can create an account and get the needed API keys:

  1. Create a new user, and give it a meaningful name like RestAPIUser and give it a good password.
  2. Set the Security Level to the role previously created to assign the user the appropriate rights.  Click Save.
  3. Click on the newly created user and scroll down to the bottom until you find the keys for API access.

  1. Copy the API Key and API Secret to a safe place.
  2. If you want to have additional security and only allow API calls from a certain IP addresses, you can specify those in the API Login Allowed From: – field

The last thing you need to be able to execute the REST API calls is the API URL. That is: https://URL_Of_Your_NoTouchCenter/easyadmin/api/v1 

Now you have all the needed information to get started with the REST API in the script language you want. The script files have all the guides you need to get started in the comments. The Python script has the most complete set of API calls that you can call, so you can use that as a reference guide.

Happy scripting!

REST API and the SDK Package in NoTouch Center 4.5 “Emerald Bay”

Rest API and the SDK Package Blog

The one feature that got my heart beating faster in the recent release of NoTouch Center was by far the SDK Package, with its ability to perform REST API calls. As the trends in IT are going towards building infrastructure with code and scripting administrative tasks instead of using the GUI, this is demonstrating that we are carefully following the industry demands to make sure our much praised management solution stays current.

How to get started

What you will need is

  1. NoTouch Center version 4.5.x or greater
  2. An API Account in NoTouch Center
  3. An environment where you can execute Python, Java, Bash or PowerShell -scripts

Getting the SDK kit from NoTouch Center

Log in to your NoTouch Console and on the top click Resources click and then About. Scroll down almost to the end, until  you reach the Extensions section.

Click on the NoTouch Center SDK Package -link to download the SDK package to your computer.

Unpack the content to a directory and you will see the following: 

Under services you will find example code on how to create custom plugins to NoTouch Center. The api folder contains examples for REST API commands in bash, JavaScript, Python and Powershell, which we will focus on in this tech-note.

Creating an Account for the API calls

In order to perform REST API calls you would need to have an account who has the rights to execute the commands requested on NoTouch Center. In addition that account needs to have the “Login via API” right.

Before you create a user account, you should create a role with the appropriate rights. Create a new role and give it suitable permissions that match what you need to perform the actions you want to complete through the REST API calls. For testing purposes, you could select the Expert template, but for production you should go with the absolute minimum rights.

Once done, search for API to make sure that Login/Via API is enabled, and click Save.

Now you can create an account and get the needed API keys:

  1. Create a new user, and give it a meaningful name like RestAPIUser and give it a good password.
  2. Set the Security Level to the role previously created to assign the user the appropriate rights.  Click Save.
  3. Click on the newly created user and scroll down to the bottom until you find the keys for API access.

  1. Copy the API Key and API Secret to a safe place.
  2. If you want to have additional security and only allow API calls from a certain IP addresses, you can specify those in the API Login Allowed From: – field

The last thing you need to be able to execute the REST API calls is the API URL. That is: https://URL_Of_Your_NoTouchCenter/easyadmin/api/v1 

Now you have all the needed information to get started with the REST API in the script language you want. The script files have all the guides you need to get started in the comments. The Python script has the most complete set of API calls that you can call, so you can use that as a reference guide.

Happy scripting!

Stratodesk Offers Scalable, Unified, and Simplified Endpoint Management – ActualTechMedia

The focus of this Spotlight Series discussion between Stratodesk CEO Emanuel Pirker and ActualTech Media…

Read more
Stratodesk and Citrix LTSR – Bringing Predictability to VDI Endpoints

Stratodesk has received certification for Citrix Ready™  verification for Citrix Virtual Apps and Desktops™ 2203…

Read more
Introducing Stratodesk NoTouch 3.4. & Stratodesk NoTouch Center 4.5.

It’s been a couple of months since Stratodesk NoTouch OS 3.3.727 was released, and this…

Read more

Sign up for your NoTouch OS Free Trial

Free Trial grants you 30 day access to Stratodesk software.









Specific questions or comments:
I agree to the privacy policy
Subscribe to Stratodesk Newsletter

Subscribe to our newsletter:

Back To Top
X