Skip to main content

RMM & Security Endpoints (cont.)

JamfDetails

Jamf Pro/Jamf School Apple MDM integration. Follows the standard CRUD pattern.

JamfDetails Schema

FieldTypeDescription
idintegerRecord ID
urlstringJamf server URL
usernamestringAPI username
new_passwordstringAPI password (write-only)
new_integration_methodbooleanUse new auth method
instancetypeintegerJamf instance type (Pro, School)
devicetypesstringDevice types to import (comma-separated)
device_typesarrayDevice types list
defaultsiteintegerDefault site for imported assets
computerassettypeintegerAsset type for computers
sitematchtypeintegerMethod for matching sites
site_linksarraySite link mappings (ExternalLink_List[])
fieldmappingsarrayComputer field mappings (IntegrationFieldMapping[])
mobilefieldmappingsarrayMobile device field mappings (IntegrationFieldMapping[])
enableintegratorbooleanEnable HaloIntegrator sync
lastsyncdatedatetimeLast successful sync
lastsyncerrorstringLast sync error

Kandji / KandjiDetails

GET /Kandji/Get — Retrieve live data from Kandji.

KandjiDetails follows the standard CRUD pattern.

KandjiDetails Schema

FieldTypeDescription
idintegerRecord ID
namestringIntegration name
urlstringKandji console URL
apiurlstringKandji API URL
new_integration_keystringAPI key (write-only)
default_devicesiteintegerDefault site for imported devices
default_devicetypeintegerDefault device type
assetimportidentifierintegerAsset matching identifier field
assetimportidentifier_fieldnamestringName of the matching field
fieldmappingsarrayAsset field mappings (IntegrationFieldMapping[])
sitemappingsarraySite matching rules (IntegrationSiteMapping[])
enableintegratorbooleanEnable HaloIntegrator sync
lastsyncdatedatetimeLast successful sync
lastsyncerrorstringLast sync error
delete_devicesbooleanRemove devices not found in Kandji
dont_create_new_devicesbooleanSkip creating new assets
dont_update_device_typebooleanPreserve existing device type
dont_move_sitebooleanPreserve existing site assignment
default_assetgroupintegerDefault asset group
assettype_choiceintegerMethod for determining asset type
mappings_xtypearrayAsset type mappings (XTypeMapping[])

TaniumDetails

Tanium endpoint security/management integration. Follows the standard CRUD pattern.

TaniumDetails Schema

FieldTypeDescription
idintegerRecord ID
namestringIntegration name
urlstringTanium server URL
apiurlstringTanium API URL
new_integration_keystringAPI key (write-only)
tokenexpirydatetimeToken expiry
default_devicesiteintegerDefault site for imported assets
default_devicetypeintegerDefault asset type
assetimportidentifierintegerAsset matching identifier field
asset_fieldmappingsarrayAsset field mappings (IntegrationFieldMapping[])
sitemappingsarraySite matching rules (IntegrationSiteMapping[])
enableintegratorbooleanEnable HaloIntegrator sync
lastsyncdatedatetimeLast successful sync
lastsyncerrorstringLast sync error
enable_alertsbooleanEnable Tanium webhook alerting
tanium_userintegerAgent user for alert tickets
tanium_tickettypeintegerTicket type for alert tickets
webhook_usernamestringWebhook authentication username
new_webhook_passwordstringWebhook password (write-only)
enable_user_matchingbooleanEnable user matching on alerts
halo_user_matching_fieldstringHalo field used for user matching
tanium_user_matching_fieldintegerTanium field used for user matching
allow_partial_user_matchbooleanAllow partial match on user fields
delete_devicesbooleanRemove devices not found in Tanium
dont_create_new_devicesbooleanSkip creating new assets
halo_integrator_import_typesarrayTypes to import (KeyPair2[])

SailPoint / SailPointDetails

Identity governance (SailPoint IdentityNow/IIQ) integration. Follows the standard CRUD pattern with additional mapping endpoints.

Additional Endpoints

MethodPathDescription
GET/SailPointRoleMappingList SailPoint role mappings
GET/SailPointUserMappingList SailPoint user mappings

SailPointDetails Schema (key fields)

FieldTypeDescription
idintegerRecord ID
guiduuidUnique identifier
namestringIntegration name (max 250)
urlstringSailPoint instance URL (max 500)
usernamestringAPI username (max 100)
new_passwordstringAPI password (write-only)
new_tokenstringAPI token (write-only)
token_expirydatetimeToken expiry
instance_idintegerInstance ID
client_top_levelintegerTop-level grouping for client sync
role_mappingsarrayRole mappings (SailPointRoleMapping[])
client_field_mappingsarrayClient field mappings (IntegrationFieldMapping[])
cab_field_mappingsarrayCAB field mappings
team_field_mappingsarrayTeam field mappings
user_field_mappingsarrayUser field mappings
agent_field_mappingsarrayAgent field mappings
user_mappingsarrayUser mappings (SailPointUserMapping[])
match_user_emailbooleanMatch users by email
match_agent_emailbooleanMatch agents by email
role_match_fieldstringSailPoint field for role matching
user_match_fieldstringSailPoint field for user matching
enable_integratorbooleanEnable HaloIntegrator sync
last_sync_datedatetimeLast successful sync
last_sync_errorstringLast sync error
deactivate_usersbooleanDeactivate removed users
deactivate_agentsbooleanDeactivate removed agents
role_delta_typeintegerDelta processing method for roles
user_delta_typeintegerDelta processing method for users
integrator_import_typesarrayTypes to import (KeyPair2[])

Virima / VirimaDetails

GET /Virima/Get — Retrieve live data from Virima.

VirimaDetails follows the standard CRUD pattern.

VirimaDetails Schema

FieldTypeDescription
idintegerRecord ID
namestringIntegration name
urlstringVirima server URL
tenantidstringVirima tenant ID
new_integration_keystringAPI key (write-only)
default_devicesiteintegerDefault site for imported assets
default_devicetypeintegerDefault asset type
assetimportidentifierintegerAsset matching identifier field
fieldmappingsarrayAsset field mappings (IntegrationFieldMapping[])
sitemappingsarraySite matching rules (IntegrationSiteMapping[])
enableintegratorbooleanEnable HaloIntegrator sync
lastsyncdatedatetimeLast successful sync
lastsyncerrorstringLast sync error

Eracent / EracentDetails

GET /Eracent/Get — Retrieve live data from Eracent.

EracentDetails follows the standard CRUD pattern.

EracentDetails Schema

FieldTypeDescription
idintegerRecord ID
namestringIntegration name
urlstringEracent server URL
usernamestringAPI username
new_integration_keystringAPI key (write-only)
new_access_tokenstringAccess token (write-only)
token_expiredatetimeToken expiry
default_devicesiteintegerDefault site for imported assets
default_devicetypeintegerDefault asset type
assetimportidentifierintegerAsset matching identifier field
fieldmappingsarrayAsset field mappings (IntegrationFieldMapping[])
sitemappingsarraySite matching rules (IntegrationSiteMapping[])
enableintegratorbooleanEnable HaloIntegrator sync
lastsyncdatedatetimeLast successful sync
lastsyncerrorstringLast sync error

Addigy / AddigyDetails

Apple MDM (Addigy) integration.

Endpoints

MethodPathDescription
GET/Addigy/GetRetrieve live data from Addigy
POST/Addigy/PostCreate/configure webhook. Body: AddigyCreateWebhook

AddigyCreateWebhook Schema

FieldTypeDescription
details_idintegerID of the AddigyDetails configuration
create_webhookbooleanWhether to create the webhook

AddigyDetails follows the standard CRUD pattern.

AddigyDetails Schema (key fields)

FieldTypeDescription
idintegerRecord ID
guiduuidUnique identifier
addigy_tenantstringAddigy tenant identifier
addigy_clientidstringAddigy client ID
new_integration_keystringAPI key (write-only)
new_webhook_keystringWebhook secret key (write-only)
addigy_defaultassetsiteintegerDefault site for imported assets
addigy_assettypeintegerDefault asset type
addigy_assetimportidentifierintegerAsset matching identifier field
addigy_dont_import_softwarebooleanSkip software inventory sync
addigy_dont_update_device_typebooleanPreserve existing device type
addigy_enable_alertingbooleanEnable Addigy alerting
addigy_alert_methodintegerAlert processing method
addigy_alert_typeintegerTicket type for alert tickets
addigy_alert_userintegerAgent user for alert tickets
addigy_clientmappingsarrayClient link mappings (ExternalLink_List[])
addigy_assetfieldmappingsarrayAsset field mappings (IntegrationFieldMapping[])
addigy_deactivate_assetsbooleanDeactivate removed assets
addigy_import_entitiesstringEntities to import (comma-separated)
halointegrator_addigybooleanEnable HaloIntegrator sync
halointegrator_addigy_lastsyncdatetimeLast successful sync
halointegrator_addigy_lasterrorstringLast sync error
addigy_apiversionintegerAddigy API version

Raynet / RaynetDetails

GET /Raynet/Get — Retrieve live data from Raynet.

RaynetDetails follows the standard CRUD pattern.

RaynetDetails Schema (key fields)

FieldTypeDescription
idintegerRecord ID
namestringIntegration name
urlstringRaynet server URL
new_integration_keystringAPI key (write-only)
default_devicesiteintegerDefault site for imported assets
default_devicetypeintegerDefault asset type
assetimportidentifierintegerAsset matching identifier field
fieldmappingsarrayAsset field mappings (IntegrationFieldMapping[])
site_rulesarraySite matching rules (IntegrationSiteMapping[])
site_mappingsarraySite link mappings (ExternalLink_List[])
enableintegratorbooleanEnable HaloIntegrator sync
lastsyncdatedatetimeLast successful sync
lastsyncerrorstringLast sync error
delete_devicesbooleanRemove devices not found in Raynet
dont_create_new_devicesbooleanSkip creating new assets
default_statusintegerDefault asset status on import
delete_statusintegerStatus to apply when asset removed
site_matching_methodintegerAlgorithm for matching sites
halo_integrator_import_typesarrayTypes to import (KeyPair2[])

GoToResolve

GoTo Resolve remote support integration.

MethodPathDescription
GET/GoToResolve/CompleteMark a GoTo Resolve session as complete
GET/GoToResolve/DownloadDownload GoTo Resolve session data

ISLOnline

ISL Online remote support integration.

MethodPathDescription
GET/ISLOnline/GetRetrieve ISL Online configuration/data
POST/ISLOnline/CreateLinkCreate a remote support link. Body: Device (device record to connect to)

Device Schema (key fields used for ISL Online link creation)

FieldTypeDescription
idintegerDevice/asset record ID
client_idintegerAssociated client ID
site_idintegerAssociated site ID
key_fieldstringPrimary identifying field value

TakeControl

SolarWinds Take Control (previously BeanstalkRemote) integration.

MethodPathDescription
GET/TakeControl/GetUrlGet a Take Control session URL. Body: array of Control records

RemoteSessionData

Remote session log and management. All remote session data from integrated tools is unified here.

Endpoints

MethodPathDescription
GET/RemoteSessionList remote session records. Requires authentication.
POST/RemoteSessionCreate remote session records. Body: array of RemoteSessionData
GET/RemoteSession/{id}Get a single session record. Query param: includedetails (boolean)
DELETE/RemoteSession/{id}Delete a session record

GET /RemoteSession Query Parameters

ParameterTypeDescription
agentstringFilter by agent name
agent_idintegerFilter by agent ID
client_idintegerFilter by client ID
site_idintegerFilter by site ID
usernamestringFilter by end-user username
countintegerLimit number of results
page_nointegerPage number for pagination
page_sizeintegerRecords per page
pageinatebooleanEnable pagination
searchstringText search across session records
orderstringPrimary sort field
order2order5stringSecondary sort fields
orderdescorderdesc5booleanSort descending for each order field
includelinkedbooleanInclude linked records

RemoteSessionData Schema

FieldTypeDescription
idintegerSession record ID
thirdpartyidstringSession ID from the remote tool
ticket_idintegerLinked ticket ID
actionnumberintegerLinked ticket action number
calllogidintegerLinked call log ID
customernamestringCustomer/client name
sitenamestringSite name
usernamestringEnd-user name
emailaddressstringEnd-user email
sessionstateintegerCurrent session state
sessionfinishedbooleanWhether session has ended
queuedatedatetimeTime session entered queue
leftqueuedatedatetimeTime session left queue
sessionstartdatedatetimeSession start time
sessionenddatedatetimeSession end time
matchedclientintegerMatched Halo client ID
matchedsiteintegerMatched Halo site ID
matcheduserstringMatched Halo user
outcomeintegerSession outcome code
phonenumberstringEnd-user phone number
notesstringSession notes
summarystringSession summary
resolvedbooleanWhether session resolved the issue
isnewreqbooleanWhether session generated a new ticket
useridintegerHalo user ID
clientidintegerHalo client ID
siteidintegerHalo site ID
time_takennumberSession duration (hours)
agent_urlstringAgent-side session URL
recording_urlstringRecording URL (if session was recorded)
module_idintegerSource module/integration ID

RemoteSessionTeams

Microsoft Teams-based remote session configuration.

MethodPathDescription
GET/RemoteSessionTeamsList Teams remote session configurations

GET /RemoteSessionTeams Query Parameters

ParameterTypeDescription
includeenabledbooleanFilter to only enabled Teams configurations
msidstringFilter by Microsoft tenant/object ID