Syxsense API

Start by clicking on their user icon in the upper right-hand corner of the Syxsense Console.Drop-down TitleDrop-down Title

Then, select the link for 'API Access Tokens (PREVIEW)'.Drop-down TitleDrop-down Title

Once the API Access Tokens link has been activated, the Console will show a new screen with all the current API access tokens associated with the current user account, along with an option to create a new API token.

Select the New Token button from this screen. Drop-down TitleDrop-down Title

From the corresponding New API Token window, create a name for the API token, set an Expiration date, add an optional IP Address lock, and select the required level of Console Access needed for this API Token.

For this example, we have selected just the Devices context.

Depending on the level of access provided to this token, different commands will be available for execution within the API. Once the desired level of access has been ascribed to this API Token, hit the save button in the upper left-hand corner of the permissions panel.  The API Token may take a few moments to generate.  

Once the token has been generated, a new screen will prompt briefly, allowing the API Token key to be recorded. This key will never be displayed in the console again, and if the key is lost, a new token must be generated. Drop-down TitleDrop-down Title

After recording the Token key, close the prompt and return to the API Access page.

The new token will show up in the list of currently active API tokens, as shown below.Drop-down TitleDrop-down Title

Click in the upper right  >  Enter your key in the value field

You can generate the Bearer apiKey by selecting  in the 'Setting' Drop-down TitleDrop-down Title

Scroll down, you will see the possible parameters for the API. 

This section automatically updates with all the new API parameters as we add them. 

Examples to start with:

• columnSet:  Use any columnset existing in Syxsense Secure to extract exactly the fields you want.  If you do not specify a column set here, Syxsense will use the default one.
• QueryName or QueryID will pull the devices that meet that query criteria.  Use the query name as defined in the Syxsense Console.
• GroupName: Pulls just the devices in a specified group.
• SiteName: Pulls a specific site.
• Search: enter any device name to pull only that devices information.

Click the  button, if you have not entered any criteria this will pull down all the devices from your computers table in a paged format, one page of 100 devices at a time (controlled by Page and pageSize parameters).

After loading you will see:

• Curl
• Request URL
• Server Response

Server Response data

• At the bottom of the Response Body, you can see the count of records retrieved, the page size, and the total page count.
• To view the second page of data change the page parameter to '2'.

To authorize the API site for calls made from the correct Syxsense Console and with the correct permissions, select the Authorize button within the API website.Drop-down TitleDrop-down Title

Once authorized, the API site will allow calls to be made to and from the renderer.

An authorized API token is shown below. Once the authorization has been verified, close the window.Drop-down TitleDrop-down Title

Now that the API has been authorized, feel free to try out any of the available API calls listed in the API configuration tool.  

Each API call can be modified to include parameters related to queries that have been generated within the Syxsense Console.  

This will allow for targeted calls to specific sections of the environment managed by Syxsense.Drop-down TitleDrop-down Title

Clicking the Try it out button will provide an output in curl format, along with an optional rendering of what the results would look like if the API were called directly in the current Syxsense Console.  

Simply hit the execute button to see the results of the API call displayed in JSON format along with the curl command syntax which generated the API call.Drop-down TitleDrop-down Title

require 'net/http'

require 'uri'

uri = URI.parse("https://api.syxsense.io/api/Computers?")

request = Net::HTTP::Get.new(uri)

request["Accept"] = "*/*"

request["Authorization"] = "Redacted"

req_options = {   

use_ssl: uri.scheme == "https",

}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|  

http.request(request)

end

puts response.body