Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
3471 lines (2496 loc) · 107 KB

SystemInsightsApi.md

File metadata and controls

3471 lines (2496 loc) · 107 KB

JCAPIv2::SystemInsightsApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
systeminsights_list_apps GET /systeminsights/apps List System Insights Apps
systeminsights_list_battery GET /systeminsights/battery List System Insights Battery
systeminsights_list_bitlocker_info GET /systeminsights/bitlocker_info List System Insights Bitlocker Info
systeminsights_list_browser_plugins GET /systeminsights/browser_plugins List System Insights Browser Plugins
systeminsights_list_chrome_extensions GET /systeminsights/chrome_extensions List System Insights Chrome Extensions
systeminsights_list_crashes GET /systeminsights/crashes List System Insights Crashes
systeminsights_list_disk_encryption GET /systeminsights/disk_encryption List System Insights Disk Encryption
systeminsights_list_disk_info GET /systeminsights/disk_info List System Insights Disk Info
systeminsights_list_etc_hosts GET /systeminsights/etc_hosts List System Insights Etc Hosts
systeminsights_list_firefox_addons GET /systeminsights/firefox_addons List System Insights Firefox Addons
systeminsights_list_groups GET /systeminsights/groups List System Insights Groups
systeminsights_list_ie_extensions GET /systeminsights/ie_extensions List System Insights IE Extensions
systeminsights_list_interface_addresses GET /systeminsights/interface_addresses List System Insights Interface Addresses
systeminsights_list_kernel_info GET /systeminsights/kernel_info List System Insights Kernel Info
systeminsights_list_launchd GET /systeminsights/launchd List System Insights Launchd
systeminsights_list_logged_in_users GET /systeminsights/logged_in_users List System Insights Logged-In Users
systeminsights_list_logical_drives GET /systeminsights/logical_drives List System Insights Logical Drives
systeminsights_list_mounts GET /systeminsights/mounts List System Insights Mounts
systeminsights_list_os_version GET /systeminsights/os_version List System Insights OS Version
systeminsights_list_patches GET /systeminsights/patches List System Insights Patches
systeminsights_list_programs GET /systeminsights/programs List System Insights Programs
systeminsights_list_safari_extensions GET /systeminsights/safari_extensions List System Insights Safari Extensions
systeminsights_list_system_apps GET /systeminsights/{system_id}/apps List System Insights System Apps
systeminsights_list_system_bitlocker_info GET /systeminsights/{system_id}/bitlocker_info List System Insights System Bitlocker Info
systeminsights_list_system_browser_plugins GET /systeminsights/{system_id}/browser_plugins List System Insights System Browser Plugins
systeminsights_list_system_chrome_extensions GET /systeminsights/{system_id}/chrome_extensions List System Insights System Chrome Extensions
systeminsights_list_system_controls GET /systeminsights/system_controls List System Insights System Control
systeminsights_list_system_disk_encryption GET /systeminsights/{system_id}/disk_encryption List System Insights System Disk Encryption
systeminsights_list_system_disk_info GET /systeminsights/{system_id}/disk_info List System Insights System Disk Info
systeminsights_list_system_etc_hosts GET /systeminsights/{system_id}/etc_hosts List System Insights System Etc Hosts
systeminsights_list_system_firefox_addons GET /systeminsights/{system_id}/firefox_addons List System Insights System Firefox Addons
systeminsights_list_system_groups GET /systeminsights/{system_id}/groups List System Insights System Groups
systeminsights_list_system_info GET /systeminsights/system_info List System Insights System Info
systeminsights_list_system_interface_addresses GET /systeminsights/{system_id}/interface_addresses List System Insights System Interface Addresses
systeminsights_list_system_kernel_info GET /systeminsights/{system_id}/kernel_info List System Insights System Kernel Info
systeminsights_list_system_logical_drives GET /systeminsights/{system_id}/logical_drives List System Insights System Logical Drives
systeminsights_list_system_mounts GET /systeminsights/{system_id}/mounts List System Insights System Mounts
systeminsights_list_system_os_version GET /systeminsights/{system_id}/os_version List System Insights System OS Version
systeminsights_list_system_patches GET /systeminsights/{system_id}/patches List System Insights System Patches
systeminsights_list_system_programs GET /systeminsights/{system_id}/programs List System Insights System Programs
systeminsights_list_system_safari_extensions GET /systeminsights/{system_id}/safari_extensions List System Insights System Safari Extensions
systeminsights_list_system_system_controls GET /systeminsights/{system_id}/system_controls List System Insights System System Controls
systeminsights_list_system_system_info GET /systeminsights/{system_id}/system_info List System Insights System System Info
systeminsights_list_system_uptime GET /systeminsights/{system_id}/uptime List System Insights System Uptime
systeminsights_list_system_users GET /systeminsights/{system_id}/users List System Insights System Users
systeminsights_list_uptime GET /systeminsights/uptime List System Insights Uptime
systeminsights_list_usb_devices GET /systeminsights/usb_devices List System Insights USB Devices
systeminsights_list_user_groups GET /systeminsights/user_groups List System Insights User Groups
systeminsights_list_users GET /systeminsights/users List System Insights Users
systeminsights_list_windows_crashes GET /systeminsights/windows_crashes List System Insights Windows Crashes

systeminsights_list_apps

Array<SystemInsightsApps> systeminsights_list_apps(content_type, accept, opts)

List System Insights Apps

Valid filter fields are system_id and bundle_name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights Apps
  result = api_instance.systeminsights_list_apps(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_apps: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsApps>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_battery

Array<SystemInsightsBattery> systeminsights_list_battery(content_type, accept, opts)

List System Insights Battery

Valid filter fields are system_id and health.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights Battery
  result = api_instance.systeminsights_list_battery(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_battery: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsBattery>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_bitlocker_info

Array<SystemInsightsBitlockerInfo> systeminsights_list_bitlocker_info(content_type, accept, opts)

List System Insights Bitlocker Info

Valid filter fields are system_id and protection_status.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Bitlocker Info
  result = api_instance.systeminsights_list_bitlocker_info(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_bitlocker_info: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsBitlockerInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_browser_plugins

Array<SystemInsightsBrowserPlugins> systeminsights_list_browser_plugins(content_type, accept, opts)

List System Insights Browser Plugins

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Browser Plugins
  result = api_instance.systeminsights_list_browser_plugins(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_browser_plugins: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsBrowserPlugins>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_chrome_extensions

Array<SystemInsightsChromeExtensions> systeminsights_list_chrome_extensions(content_type, accept, opts)

List System Insights Chrome Extensions

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Chrome Extensions
  result = api_instance.systeminsights_list_chrome_extensions(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_chrome_extensions: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsChromeExtensions>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_crashes

Array<SystemInsightsCrashes> systeminsights_list_crashes(content_type, accept, opts)

List System Insights Crashes

Valid filter fields are system_id and identifier.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights Crashes
  result = api_instance.systeminsights_list_crashes(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_crashes: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsCrashes>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_disk_encryption

Array<SystemInsightsDiskEncryption> systeminsights_list_disk_encryption(content_type, accept, opts)

List System Insights Disk Encryption

Valid filter fields are system_id and encryption_status.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Disk Encryption
  result = api_instance.systeminsights_list_disk_encryption(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_disk_encryption: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsDiskEncryption>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_disk_info

Array<SystemInsightsDiskInfo> systeminsights_list_disk_info(content_type, accept, opts)

List System Insights Disk Info

Valid filter fields are system_id and disk_index.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Disk Info
  result = api_instance.systeminsights_list_disk_info(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_disk_info: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsDiskInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_etc_hosts

Array<SystemInsightsEtcHosts> systeminsights_list_etc_hosts(content_type, accept, opts)

List System Insights Etc Hosts

Valid filter fields are system_id and address.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Etc Hosts
  result = api_instance.systeminsights_list_etc_hosts(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_etc_hosts: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsEtcHosts>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_firefox_addons

Array<SystemInsightsFirefoxAddons> systeminsights_list_firefox_addons(content_type, accept, opts)

List System Insights Firefox Addons

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Firefox Addons
  result = api_instance.systeminsights_list_firefox_addons(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_firefox_addons: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsFirefoxAddons>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_groups

Array<SystemInsightsGroups> systeminsights_list_groups(content_type, accept, opts)

List System Insights Groups

Valid filter fields are system_id and groupname.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Groups
  result = api_instance.systeminsights_list_groups(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_groups: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsGroups>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_ie_extensions

Array<SystemInsightsIeExtensions> systeminsights_list_ie_extensions(content_type, accept, opts)

List System Insights IE Extensions

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights IE Extensions
  result = api_instance.systeminsights_list_ie_extensions(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_ie_extensions: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsIeExtensions>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_interface_addresses

Array<SystemInsightsInterfaceAddresses> systeminsights_list_interface_addresses(content_type, accept, opts)

List System Insights Interface Addresses

Valid filter fields are system_id and address.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Interface Addresses
  result = api_instance.systeminsights_list_interface_addresses(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_interface_addresses: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsInterfaceAddresses>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_kernel_info

Array<SystemInsightsKernelInfo> systeminsights_list_kernel_info(content_type, accept, opts)

List System Insights Kernel Info

Valid filter fields are system_id and version.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Kernel Info
  result = api_instance.systeminsights_list_kernel_info(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_kernel_info: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsKernelInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_launchd

Array<SystemInsightsLaunchd> systeminsights_list_launchd(content_type, accept, opts)

List System Insights Launchd

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights Launchd
  result = api_instance.systeminsights_list_launchd(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_launchd: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsLaunchd>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_logged_in_users

Array<SystemInsightsLoggedInUsers> systeminsights_list_logged_in_users(content_type, accept, opts)

List System Insights Logged-In Users

Valid filter fields are system_id and user.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights Logged-In Users
  result = api_instance.systeminsights_list_logged_in_users(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_logged_in_users: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsLoggedInUsers>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_logical_drives

Array<SystemInsightsLogicalDrvies> systeminsights_list_logical_drives(content_type, accept, opts)

List System Insights Logical Drives

Valid filter fields are system_id and device_id.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Logical Drives
  result = api_instance.systeminsights_list_logical_drives(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_logical_drives: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsLogicalDrvies>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_mounts

Array<SystemInsightsMounts> systeminsights_list_mounts(content_type, accept, opts)

List System Insights Mounts

Valid filter fields are system_id and path.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Mounts
  result = api_instance.systeminsights_list_mounts(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_mounts: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsMounts>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_os_version

Array<SystemInsightsOsVersion> systeminsights_list_os_version(content_type, accept, opts)

List System Insights OS Version

Valid filter fields are system_id and version.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights OS Version
  result = api_instance.systeminsights_list_os_version(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_os_version: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsOsVersion>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_patches

Array<SystemInsightsPatches> systeminsights_list_patches(content_type, accept, opts)

List System Insights Patches

Valid filter fields are system_id and hotfix_id.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Patches
  result = api_instance.systeminsights_list_patches(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_patches: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsPatches>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_programs

Array<SystemInsightsPrograms> systeminsights_list_programs(content_type, accept, opts)

List System Insights Programs

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Programs
  result = api_instance.systeminsights_list_programs(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_programs: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsPrograms>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_safari_extensions

Array<SystemInsightsSafariExtensions> systeminsights_list_safari_extensions(content_type, accept, opts)

List System Insights Safari Extensions

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Safari Extensions
  result = api_instance.systeminsights_list_safari_extensions(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_safari_extensions: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsSafariExtensions>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_apps

Array<SystemInsightsApps> systeminsights_list_system_apps(system_id, content_type, accept, opts)

List System Insights System Apps

Valid filter fields are bundle_name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Apps
  result = api_instance.systeminsights_list_system_apps(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_apps: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsApps>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_bitlocker_info

Array<SystemInsightsBitlockerInfo> systeminsights_list_system_bitlocker_info(system_id, content_type, accept, opts)

List System Insights System Bitlocker Info

Valid filter fields are protection_status.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Bitlocker Info
  result = api_instance.systeminsights_list_system_bitlocker_info(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_bitlocker_info: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsBitlockerInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_browser_plugins

Array<SystemInsightsBrowserPlugins> systeminsights_list_system_browser_plugins(system_id, content_type, accept, opts)

List System Insights System Browser Plugins

Valid filter fields are name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Browser Plugins
  result = api_instance.systeminsights_list_system_browser_plugins(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_browser_plugins: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsBrowserPlugins>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_chrome_extensions

Array<SystemInsightsChromeExtensions> systeminsights_list_system_chrome_extensions(system_id, content_type, accept, opts)

List System Insights System Chrome Extensions

Valid filter fields are name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Chrome Extensions
  result = api_instance.systeminsights_list_system_chrome_extensions(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_chrome_extensions: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsChromeExtensions>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_controls

Array<SystemInsightsSystemControls> systeminsights_list_system_controls(content_type, accept, opts)

List System Insights System Control

Valid filter fields are system_id and name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Control
  result = api_instance.systeminsights_list_system_controls(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_controls: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsSystemControls>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_disk_encryption

Array<SystemInsightsDiskEncryption> systeminsights_list_system_disk_encryption(system_id, content_type, accept, opts)

List System Insights System Disk Encryption

Valid filter fields are encryption_status.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Disk Encryption
  result = api_instance.systeminsights_list_system_disk_encryption(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_disk_encryption: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsDiskEncryption>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_disk_info

Array<SystemInsightsBitlockerInfo> systeminsights_list_system_disk_info(system_id, content_type, accept, opts)

List System Insights System Disk Info

Valid filter fields are disk_index.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Disk Info
  result = api_instance.systeminsights_list_system_disk_info(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_disk_info: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsBitlockerInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_etc_hosts

Array<SystemInsightsBitlockerInfo> systeminsights_list_system_etc_hosts(system_id, content_type, accept, opts)

List System Insights System Etc Hosts

Valid filter fields are address.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Etc Hosts
  result = api_instance.systeminsights_list_system_etc_hosts(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_etc_hosts: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsBitlockerInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_firefox_addons

Array<SystemInsightsFirefoxAddons> systeminsights_list_system_firefox_addons(system_id, content_type, accept, opts)

List System Insights System Firefox Addons

Valid filter fields are name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Firefox Addons
  result = api_instance.systeminsights_list_system_firefox_addons(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_firefox_addons: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsFirefoxAddons>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_groups

Array<SystemInsightsGroups> systeminsights_list_system_groups(system_id, content_type, accept, opts)

List System Insights System Groups

Valid filter fields are groupname.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Groups
  result = api_instance.systeminsights_list_system_groups(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_groups: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsGroups>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_info

Array<SystemInsightsSystemInfo> systeminsights_list_system_info(content_type, accept, opts)

List System Insights System Info

Valid filter fields are system_id and cpu_subtype.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Info
  result = api_instance.systeminsights_list_system_info(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_info: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsSystemInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_interface_addresses

Array<SystemInsightsInterfaceAddresses> systeminsights_list_system_interface_addresses(system_id, content_type, accept, opts)

List System Insights System Interface Addresses

Valid filter fields are address.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Interface Addresses
  result = api_instance.systeminsights_list_system_interface_addresses(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_interface_addresses: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsInterfaceAddresses>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_kernel_info

Array<SystemInsightsKernelInfo> systeminsights_list_system_kernel_info(system_id, content_type, accept, opts)

List System Insights System Kernel Info

Valid filter fields are version.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Kernel Info
  result = api_instance.systeminsights_list_system_kernel_info(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_kernel_info: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsKernelInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_logical_drives

Array<SystemInsightsLogicalDrvies> systeminsights_list_system_logical_drives(system_id, content_type, accept, opts)

List System Insights System Logical Drives

Valid filter fields are device_id.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Logical Drives
  result = api_instance.systeminsights_list_system_logical_drives(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_logical_drives: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsLogicalDrvies>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_mounts

Array<SystemInsightsMounts> systeminsights_list_system_mounts(system_id, content_type, accept, opts)

List System Insights System Mounts

Valid filter fields are path.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Mounts
  result = api_instance.systeminsights_list_system_mounts(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_mounts: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsMounts>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_os_version

Array<SystemInsightsOsVersion> systeminsights_list_system_os_version(system_id, content_type, accept, opts)

List System Insights System OS Version

Valid filter fields are version.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System OS Version
  result = api_instance.systeminsights_list_system_os_version(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_os_version: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsOsVersion>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_patches

Array<SystemInsightsPatches> systeminsights_list_system_patches(system_id, content_type, accept, opts)

List System Insights System Patches

Valid filter fields are hotfix_id .

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Patches
  result = api_instance.systeminsights_list_system_patches(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_patches: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsPatches>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_programs

Array<SystemInsightsPrograms> systeminsights_list_system_programs(system_id, content_type, accept, opts)

List System Insights System Programs

Valid filter fields are name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Programs
  result = api_instance.systeminsights_list_system_programs(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_programs: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsPrograms>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_safari_extensions

Array<SystemInsightsSafariExtensions> systeminsights_list_system_safari_extensions(system_id, content_type, accept, opts)

List System Insights System Safari Extensions

Valid filter fields are name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Safari Extensions
  result = api_instance.systeminsights_list_system_safari_extensions(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_safari_extensions: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsSafariExtensions>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_system_controls

Array<SystemInsightsSystemControls> systeminsights_list_system_system_controls(system_id, content_type, accept, opts)

List System Insights System System Controls

Valid filter fields are name.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System System Controls
  result = api_instance.systeminsights_list_system_system_controls(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_system_controls: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsSystemControls>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_system_info

Array<SystemInsightsSystemInfo> systeminsights_list_system_system_info(system_id, content_type, accept, opts)

List System Insights System System Info

Valid filter fields are cpu_subtype.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System System Info
  result = api_instance.systeminsights_list_system_system_info(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_system_info: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsSystemInfo>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_uptime

Array<SystemInsightsUptime> systeminsights_list_system_uptime(system_id, content_type, accept, opts)

List System Insights System Uptime

Valid filter fields are days.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Uptime
  result = api_instance.systeminsights_list_system_uptime(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_uptime: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsUptime>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_system_users

Array<SystemInsightsUsers> systeminsights_list_system_users(system_id, content_type, accept, opts)

List System Insights System Users

Valid filter fields are username.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

system_id = "system_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights System Users
  result = api_instance.systeminsights_list_system_users(system_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_system_users: #{e}"
end

Parameters

Name Type Description Notes
system_id String
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsUsers>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_uptime

Array<SystemInsightsUptime> systeminsights_list_uptime(content_type, accept, opts)

List System Insights Uptime

Valid filter fields are system_id and days.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Uptime
  result = api_instance.systeminsights_list_uptime(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_uptime: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsUptime>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_usb_devices

Array<SystemInsightsUsbDevices> systeminsights_list_usb_devices(content_type, accept, opts)

List System Insights USB Devices

Valid filter fields are system_id and model.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights USB Devices
  result = api_instance.systeminsights_list_usb_devices(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_usb_devices: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsUsbDevices>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_user_groups

Array<SystemInsightsUserGroups> systeminsights_list_user_groups(content_type, accept, opts)

List System Insights User Groups

Only valid filter field is system_id.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights User Groups
  result = api_instance.systeminsights_list_user_groups(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_user_groups: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsUserGroups>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_users

Array<SystemInsightsUsers> systeminsights_list_users(content_type, accept, opts)

List System Insights Users

Valid filter fields are system_id and username.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
  x_org_id: "" # String | 
}

begin
  #List System Insights Users
  result = api_instance.systeminsights_list_users(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_users: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]
x_org_id String [optional] [default to ]

Return type

Array<SystemInsightsUsers>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

systeminsights_list_windows_crashes

Array<SystemInsightsWindowsCrashes> systeminsights_list_windows_crashes(content_type, accept, opts)

List System Insights Windows Crashes

Valid filter fields are system_id and type.

Example

# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv2::SystemInsightsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  limit: 10, # Integer | 
  x_org_id: "" # String | 
  skip: 0, # Integer | The offset into the records to return.
  filter: ["filter_example"], # Array<String> | Supported operators are: eq
}

begin
  #List System Insights Windows Crashes
  result = api_instance.systeminsights_list_windows_crashes(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling SystemInsightsApi->systeminsights_list_windows_crashes: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
limit Integer [optional] [default to 10]
x_org_id String [optional] [default to ]
skip Integer The offset into the records to return. [optional] [default to 0]
filter Array<String> Supported operators are: eq [optional]

Return type

Array<SystemInsightsWindowsCrashes>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json