Systeminsights 36 endpoints

GET /systeminsights/interface_addresses List System Insights Interface Addresses

Valid filter fields are system_id and address.

operationId: SystemInsights_listInterfaceAddresses

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/interface_addresses

GET /systeminsights/interface_details List System Insights Interface Details

Valid filter fields are system_id and interface.

operationId: SystemInsights_listInterfaceDetails

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/interface_details

GET /systeminsights/kernel_info List System Insights Kernel Info

Valid filter fields are system_id and version.

operationId: SystemInsights_getKernelInfo

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/kernel_info

GET /systeminsights/launchd List System Insights Launchd

Valid filter fields are system_id and name.

operationId: SystemInsights_listLaunchd

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/launchd

GET /systeminsights/linux_packages List System Insights Linux Packages

Lists all programs for Linux devices. For macOS devices, use List System Insights System Apps. For windows devices, use List System Insights System Apps.

Valid filter fields are name and package_format.

operationId: SystemInsights_listLinuxPackages

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/linux_packages

GET /systeminsights/logged_in_users List System Insights Logged-In Users

Valid filter fields are system_id and user.

operationId: SystemInsights_listLoggedInUsers

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/logged_in_users

GET /systeminsights/logical_drives List System Insights Logical Drives

Valid filter fields are system_id and device_id.

operationId: SystemInsights_listLogicalDrives

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/logical_drives

GET /systeminsights/managed_policies List System Insights Managed Policies

Valid filter fields are system_id and domain.

operationId: SystemInsights_listManagedPolicies

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/managed_policies

GET /systeminsights/mounts List System Insights Mounts

Valid filter fields are system_id and path.

operationId: SystemInsights_listMounts

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/mounts

GET /systeminsights/os_version List System Insights OS Version

Valid filter fields are system_id and version.

operationId: SystemInsights_getOsVersion

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/os_version

GET /systeminsights/patches List System Insights Patches

Valid filter fields are system_id and hotfix_id.

operationId: SystemInsights_listPatches

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/patches

GET /systeminsights/programs List System Insights Programs

Lists all programs for Windows devices. For macOS devices, use List System Insights Apps.

Valid filter fields are system_id and name.

operationId: SystemInsights_listPrograms

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/programs

GET /systeminsights/python_packages List System Insights Python Packages

Valid filter fields are system_id and name.

operationId: SystemInsights_listPythonPackages

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/python_packages

GET /systeminsights/safari_extensions List System Insights Safari Extensions

Valid filter fields are system_id and name.

operationId: SystemInsights_listSafariExtensions

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/safari_extensions

GET /systeminsights/scheduled_tasks List System Insights Scheduled Tasks

Valid filter fields are system_id and enabled.

operationId: SystemInsights_listScheduledTasks

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/scheduled_tasks

GET /systeminsights/secureboot List System Insights Secure Boot

Valid filter fields are system_id.

operationId: SystemInsights_listSecureBoot

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

400 —

GET /systeminsights/secureboot

GET /systeminsights/services List System Insights Services

Valid filter fields are system_id and name.

operationId: SystemInsights_listServices

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/services

GET /systeminsights/shadow LIst System Insights Shadow

Valid filter fields are system_id and username.

operationId: SystemInsights_listShadowData

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/shadow

GET /systeminsights/shared_folders List System Insights Shared Folders

Valid filter fields are system_id and name.

operationId: SystemInsights_listSharedFolders

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/shared_folders

GET /systeminsights/shared_resources List System Insights Shared Resources

Valid filter fields are system_id and type.

operationId: SystemInsights_listSharedResources

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/shared_resources

GET /systeminsights/sharing_preferences List System Insights Sharing Preferences

Only valid filed field is system_id.

operationId: SystemInsights_listSharingPreferences

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/sharing_preferences

GET /systeminsights/sip_config List System Insights SIP Config

Valid filter fields are system_id and enabled.

operationId: SystemInsights_getSipConfig

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/sip_config

GET /systeminsights/startup_items List System Insights Startup Items

Valid filter fields are system_id and name.

operationId: SystemInsights_listStartupItems

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/startup_items

GET /systeminsights/system_controls List System Insights System Control

Valid filter fields are system_id and name.

operationId: SystemInsights_listSystemControls

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3` Note: You can only filter by `system_id` and `name`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/system_controls

GET /systeminsights/system_info List System Insights System Info

Valid filter fields are system_id and cpu_subtype.

operationId: SystemInsights_getSystemInfoList

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/system_info

GET /systeminsights/tpm_info List System Insights TPM Info

Valid filter fields are system_id.

operationId: SystemInsights_getTpmInfo

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

400 —

GET /systeminsights/tpm_info

GET /systeminsights/uptime List System Insights Uptime

Valid filter fields are system_id and days.

operationId: SystemInsights_listUptime

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, gte, in. e.g: Filter for single value: `filter=field:gte:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/uptime

GET /systeminsights/usb_devices List System Insights USB Devices

Valid filter fields are system_id and model.

operationId: SystemInsights_listUsbDevices

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/usb_devices

GET /systeminsights/user_groups List System Insights User Groups

Only valid filter field is system_id.

operationId: SystemInsights_getUserGroups

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/user_groups

GET /systeminsights/user_ssh_keys List System Insights User SSH Keys

Valid filter fields are system_id and uid.

operationId: SystemInsights_listUserSshKeys

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/user_ssh_keys

GET /systeminsights/userassist List System Insights User Assist

Valid filter fields are system_id.

operationId: SystemInsights_listUserAssist

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

400 —

GET /systeminsights/userassist

GET /systeminsights/users List System Insights Users

Valid filter fields are system_id and username.

operationId: SystemInsights_listUsers

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/users

GET /systeminsights/wifi_networks List System Insights WiFi Networks

Valid filter fields are system_id and security_type.

operationId: SystemInsights_listWifiNetworks

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/wifi_networks

GET /systeminsights/wifi_status List System Insights WiFi Status

Valid filter fields are system_id and security_type.

operationId: SystemInsights_listWifiStatus

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/wifi_status

GET /systeminsights/windows_security_center List System Insights Windows Security Center

Valid filter fields are system_id.

operationId: SystemInsights_listWindowsSecurityCenter

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

400 —

GET /systeminsights/windows_security_center

GET /systeminsights/windows_security_products List System Insights Windows Security Products

Valid filter fields are system_id and state.

operationId: SystemInsights_listWindowsSecurityProducts

Parameters

Name	In	Required	Type	Description
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. e.g: Sort by single field: `sort=field` Sort descending by single field: `sort=-field` Sort by multiple fields: `sort=field1,-field2,field3`
filter	query	optional	array	Supported operators are: eq, in. e.g: Filter for single value: `filter=field:eq:value` Filter for any value in a list: (note “pipe” character: `\|` separating values) `filter=field:in:value1\|value2\|value3`
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	—

Responses

200 —

GET /systeminsights/windows_security_products

Systems 6 endpoints

POST /accessrequests Create Access Request

Endpoint for adding a new access request

operationId: AccessRequestApi_CreateAccessRequest

Request Body

required

application/json

schema jumpcloud.ingresso.CreateAccessRequestsRequest

Property	Type	Required
expiry	string	optional
remarks	string	optional
resourceId	string	optional
operationId	string	optional
requestorId	string	optional
resourceType	string	optional
applicationIntId	string	optional
additionalAttributes	object	optional
organizationObjectId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /accessrequests

GET /accessrequests/{accessId} Get all Access Requests by Access Id

Endpoint for getting all access requests by access id

operationId: AccessRequestApi_GetAccessRequest

Parameters

Name	In	Required	Type	Description
accessId	path	required	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /accessrequests/{accessId}

PUT /accessrequests/{accessId} Update access request by id

Endpoint for updating access request by id

operationId: AccessRequestApi_UpdateAccessRequest

Parameters

Name	In	Required	Type	Description
accessId	path	required	string	—

Request Body

required

application/json

schema AccessRequestApiUpdateAccessRequestRequest

Property	Type	Required
expiry	string	optional
remarks	string	optional
additionalAttributes	object	optional
organizationObjectId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PUT /accessrequests/{accessId}

POST /accessrequests/{accessId}/revoke Revoke access request by id

Endpoint for revoking access request by id

operationId: AccessRequestApi_RevokeAccessRequest

Parameters

Name	In	Required	Type	Description
accessId	path	required	string	—

Responses

default

An unexpected error response.

200

A successful response.

POST /accessrequests/{accessId}/revoke

GET /systems/{system_id}/fdekey Get System FDE Key

This endpoint will return the current (latest) fde key saved for a system.

operationId: systems_getFDEKey

Parameters

Name	In	Required	Type	Description
system_id	path	required	string	—
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.

Responses

200 —

400 —

401 —

403 —

404 —

409 —

500 —

GET /systems/{system_id}/fdekey

GET /systems/{system_id}/softwareappstatuses List the associated Software Application Statuses of a System

This endpoint returns all the statuses of the associated Software Applications from the provided JumpCloud system ID.

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/systems/{system_id}/softwareappstatuses \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'

operationId: systems_ListSoftwareAppsWithStatuses

Parameters

Name	In	Required	Type	Description
system_id	path	required	string	ObjectID of the System.
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
filter	query	optional	array	A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group`
limit	query	optional	integer	The number of records to return at once. Limited to 100.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.

Responses

200

GET /systems/{system_id}/softwareappstatuses

Systemsorganizationsettings 4 endpoints

GET /devices/settings/defaultpasswordsync Get the Default Password Sync Setting

Gets the Default Password Sync Setting for an Organization.

operationId: SystemsOrgSettings_GetDefaultPasswordSyncSettings

Parameters

Name	In	Required	Type	Description
organizationObjectId	query	optional	string	—

Responses

default

An unexpected error response.

200

Setting successfully retrieved.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

GET /devices/settings/defaultpasswordsync

PUT /devices/settings/defaultpasswordsync Set the Default Password Sync Setting

Sets the Default Password Sync Setting for an Organization.

operationId: SystemsOrgSettings_SetDefaultPasswordSyncSettings

Request Body

required

application/json

schema devices.SetDefaultPasswordSyncSettingsRequest

Property	Type	Required
enabled	boolean	optional
organizationObjectId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

204

Setting successfully changed.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

PUT /devices/settings/defaultpasswordsync

GET /devices/settings/signinwithjumpcloud Get the Sign In with JumpCloud Settings

Gets the Sign In with JumpCloud Settings for an Organization.

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/devices/settings/signinwithjumpcloud \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key:{API_KEY}'

operationId: SystemsOrgSettings_GetSignInWithJumpCloudSettings

Parameters

Name	In	Required	Type	Description
organizationObjectId	query	optional	string	—

Responses

default

An unexpected error response.

200

Settings successfully retrieved.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

GET /devices/settings/signinwithjumpcloud

PUT /devices/settings/signinwithjumpcloud Set the Sign In with JumpCloud Settings

Sets the Sign In with JumpCloud Settings for an Organization.

Sample Request

curl -X PUT https://console.jumpcloud.com/api/v2/devices/settings/signinwithjumpcloud \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key:{API_KEY}' \
  -d '{"settings":[{"osFamily":"WINDOWS","enabled":true,"defaultPermission":"STANDARD"}]}'

operationId: SystemsOrgSettings_SetSignInWithJumpCloudSettings

Request Body

required

application/json

schema devices.SetSignInWithJumpCloudSettingsRequest

Property	Type	Required
settings	array	optional
└ enabled	boolean	optional
└ osFamily	string	optional
└ defaultPermission	string	optional
organizationObjectId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

204

Settings successfully changed.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

PUT /devices/settings/signinwithjumpcloud

Usergroups 4 endpoints

GET /usergroups List all User Groups

This endpoint returns all User Groups.

Available filter fields:

name
disabled
type
membershipMethod
suggestionCounts.add
suggestionCounts.remove
suggestionCounts.total
attributes.sudo.enabled
attributes.sudo.withoutPassword

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/usergroups \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'

operationId: UserGroups_listAll

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.
filter	query	optional	array	A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group`
limit	query	optional	integer	The number of records to return at once. Limited to 100.
skip	query	optional	integer	The offset into the records to return.
sort	query	optional	array	The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.

Responses

default

Unexpected error

200

GET /usergroups

POST /usergroups Create a new User Group

This endpoint allows you to create a new User Group.

See the Dynamic Group Configuration KB article for more details on maintaining a Dynamic Group.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/usergroups \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "name": "{Group_Name}"
  }'

operationId: UserGroups_createNewGroup

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.

Request Body

application/json

schema UserGroupPost

Property	Type	Required
name	string	required
email	string	optional
attributes	object	optional
└ sudo	object	optional
└ enabled	boolean	required
└ withoutPassword	boolean	required
└ ldapGroups	array	optional
└ name	string	optional
└ posixGroups	array	optional
└ id	integer	required
└ name	string	required
└ radius	object	optional
└ reply	array	optional
└ name	string	required
└ value	string	required
└ sambaEnabled	boolean	optional
description	string	optional
memberQuery	object	optional
└ queryType	string	required
└ filters	array	optional
membershipMethod	string	optional
memberQueryExemptions	array	optional
└ id	string	required
└ type	string	required
└ attributes	object	optional
memberSuggestionsNotify	boolean	optional

Responses

201

Created

POST /usergroups

GET /usergroups/{group_id}/suggestions List Suggestions for a User Group

This endpoint returns available suggestions for a given group

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/suggestions \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'

operationId: UserGroups_getSuggestions

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
limit	query	optional	integer	The number of records to return at once. Limited to 100.
skip	query	optional	integer	The offset into the records to return.
group_id	path	required	string	ID of the group

Responses

200

GET /usergroups/{group_id}/suggestions

POST /usergroups/{group_id}/suggestions Apply Suggestions for a User Group

This endpoint applies the suggestions for the specified user group.

Sample Request

curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/suggestions \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
         "user_ids": ["212345678901234567890123",
                      "123456789012345678901234"]
     }'

operationId: UserGroups_applySuggestions

Parameters

Name	In	Required	Type	Description
x-org-id	header	optional	string	Organization identifier that can be obtained from console settings.
group_id	path	required	string	ID of the group

Request Body

required

application/json

schema UserGroupsApplySuggestionsRequest

Property	Type	Required
user_ids	array	optional

Responses

200

POST /usergroups/{group_id}/suggestions