RMM & Security Endpoints (cont.)
JamfDetails
Jamf Pro/Jamf School Apple MDM integration. Follows the standard CRUD pattern.
JamfDetails Schema
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
url | string | Jamf server URL |
username | string | API username |
new_password | string | API password (write-only) |
new_integration_method | boolean | Use new auth method |
instancetype | integer | Jamf instance type (Pro, School) |
devicetypes | string | Device types to import (comma-separated) |
device_types | array | Device types list |
defaultsite | integer | Default site for imported assets |
computerassettype | integer | Asset type for computers |
sitematchtype | integer | Method for matching sites |
site_links | array | Site link mappings (ExternalLink_List[]) |
fieldmappings | array | Computer field mappings (IntegrationFieldMapping[]) |
mobilefieldmappings | array | Mobile device field mappings (IntegrationFieldMapping[]) |
enableintegrator | boolean | Enable HaloIntegrator sync |
lastsyncdate | datetime | Last successful sync |
lastsyncerror | string | Last sync error |
Kandji / KandjiDetails
GET /Kandji/Get — Retrieve live data from Kandji.
KandjiDetails follows the standard CRUD pattern.
KandjiDetails Schema
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
name | string | Integration name |
url | string | Kandji console URL |
apiurl | string | Kandji API URL |
new_integration_key | string | API key (write-only) |
default_devicesite | integer | Default site for imported devices |
default_devicetype | integer | Default device type |
assetimportidentifier | integer | Asset matching identifier field |
assetimportidentifier_fieldname | string | Name of the matching field |
fieldmappings | array | Asset field mappings (IntegrationFieldMapping[]) |
sitemappings | array | Site matching rules (IntegrationSiteMapping[]) |
enableintegrator | boolean | Enable HaloIntegrator sync |
lastsyncdate | datetime | Last successful sync |
lastsyncerror | string | Last sync error |
delete_devices | boolean | Remove devices not found in Kandji |
dont_create_new_devices | boolean | Skip creating new assets |
dont_update_device_type | boolean | Preserve existing device type |
dont_move_site | boolean | Preserve existing site assignment |
default_assetgroup | integer | Default asset group |
assettype_choice | integer | Method for determining asset type |
mappings_xtype | array | Asset type mappings (XTypeMapping[]) |
TaniumDetails
Tanium endpoint security/management integration. Follows the standard CRUD pattern.
TaniumDetails Schema
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
name | string | Integration name |
url | string | Tanium server URL |
apiurl | string | Tanium API URL |
new_integration_key | string | API key (write-only) |
tokenexpiry | datetime | Token expiry |
default_devicesite | integer | Default site for imported assets |
default_devicetype | integer | Default asset type |
assetimportidentifier | integer | Asset matching identifier field |
asset_fieldmappings | array | Asset field mappings (IntegrationFieldMapping[]) |
sitemappings | array | Site matching rules (IntegrationSiteMapping[]) |
enableintegrator | boolean | Enable HaloIntegrator sync |
lastsyncdate | datetime | Last successful sync |
lastsyncerror | string | Last sync error |
enable_alerts | boolean | Enable Tanium webhook alerting |
tanium_user | integer | Agent user for alert tickets |
tanium_tickettype | integer | Ticket type for alert tickets |
webhook_username | string | Webhook authentication username |
new_webhook_password | string | Webhook password (write-only) |
enable_user_matching | boolean | Enable user matching on alerts |
halo_user_matching_field | string | Halo field used for user matching |
tanium_user_matching_field | integer | Tanium field used for user matching |
allow_partial_user_match | boolean | Allow partial match on user fields |
delete_devices | boolean | Remove devices not found in Tanium |
dont_create_new_devices | boolean | Skip creating new assets |
halo_integrator_import_types | array | Types to import (KeyPair2[]) |
SailPoint / SailPointDetails
Identity governance (SailPoint IdentityNow/IIQ) integration. Follows the standard CRUD pattern with additional mapping endpoints.
Additional Endpoints
| Method | Path | Description |
|---|---|---|
GET | /SailPointRoleMapping | List SailPoint role mappings |
GET | /SailPointUserMapping | List SailPoint user mappings |
SailPointDetails Schema (key fields)
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
guid | uuid | Unique identifier |
name | string | Integration name (max 250) |
url | string | SailPoint instance URL (max 500) |
username | string | API username (max 100) |
new_password | string | API password (write-only) |
new_token | string | API token (write-only) |
token_expiry | datetime | Token expiry |
instance_id | integer | Instance ID |
client_top_level | integer | Top-level grouping for client sync |
role_mappings | array | Role mappings (SailPointRoleMapping[]) |
client_field_mappings | array | Client field mappings (IntegrationFieldMapping[]) |
cab_field_mappings | array | CAB field mappings |
team_field_mappings | array | Team field mappings |
user_field_mappings | array | User field mappings |
agent_field_mappings | array | Agent field mappings |
user_mappings | array | User mappings (SailPointUserMapping[]) |
match_user_email | boolean | Match users by email |
match_agent_email | boolean | Match agents by email |
role_match_field | string | SailPoint field for role matching |
user_match_field | string | SailPoint field for user matching |
enable_integrator | boolean | Enable HaloIntegrator sync |
last_sync_date | datetime | Last successful sync |
last_sync_error | string | Last sync error |
deactivate_users | boolean | Deactivate removed users |
deactivate_agents | boolean | Deactivate removed agents |
role_delta_type | integer | Delta processing method for roles |
user_delta_type | integer | Delta processing method for users |
integrator_import_types | array | Types to import (KeyPair2[]) |
Virima / VirimaDetails
GET /Virima/Get — Retrieve live data from Virima.
VirimaDetails follows the standard CRUD pattern.
VirimaDetails Schema
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
name | string | Integration name |
url | string | Virima server URL |
tenantid | string | Virima tenant ID |
new_integration_key | string | API key (write-only) |
default_devicesite | integer | Default site for imported assets |
default_devicetype | integer | Default asset type |
assetimportidentifier | integer | Asset matching identifier field |
fieldmappings | array | Asset field mappings (IntegrationFieldMapping[]) |
sitemappings | array | Site matching rules (IntegrationSiteMapping[]) |
enableintegrator | boolean | Enable HaloIntegrator sync |
lastsyncdate | datetime | Last successful sync |
lastsyncerror | string | Last sync error |
Eracent / EracentDetails
GET /Eracent/Get — Retrieve live data from Eracent.
EracentDetails follows the standard CRUD pattern.
EracentDetails Schema
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
name | string | Integration name |
url | string | Eracent server URL |
username | string | API username |
new_integration_key | string | API key (write-only) |
new_access_token | string | Access token (write-only) |
token_expire | datetime | Token expiry |
default_devicesite | integer | Default site for imported assets |
default_devicetype | integer | Default asset type |
assetimportidentifier | integer | Asset matching identifier field |
fieldmappings | array | Asset field mappings (IntegrationFieldMapping[]) |
sitemappings | array | Site matching rules (IntegrationSiteMapping[]) |
enableintegrator | boolean | Enable HaloIntegrator sync |
lastsyncdate | datetime | Last successful sync |
lastsyncerror | string | Last sync error |
Addigy / AddigyDetails
Apple MDM (Addigy) integration.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /Addigy/Get | Retrieve live data from Addigy |
POST | /Addigy/Post | Create/configure webhook. Body: AddigyCreateWebhook |
AddigyCreateWebhook Schema
| Field | Type | Description |
|---|---|---|
details_id | integer | ID of the AddigyDetails configuration |
create_webhook | boolean | Whether to create the webhook |
AddigyDetails follows the standard CRUD pattern.
AddigyDetails Schema (key fields)
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
guid | uuid | Unique identifier |
addigy_tenant | string | Addigy tenant identifier |
addigy_clientid | string | Addigy client ID |
new_integration_key | string | API key (write-only) |
new_webhook_key | string | Webhook secret key (write-only) |
addigy_defaultassetsite | integer | Default site for imported assets |
addigy_assettype | integer | Default asset type |
addigy_assetimportidentifier | integer | Asset matching identifier field |
addigy_dont_import_software | boolean | Skip software inventory sync |
addigy_dont_update_device_type | boolean | Preserve existing device type |
addigy_enable_alerting | boolean | Enable Addigy alerting |
addigy_alert_method | integer | Alert processing method |
addigy_alert_type | integer | Ticket type for alert tickets |
addigy_alert_user | integer | Agent user for alert tickets |
addigy_clientmappings | array | Client link mappings (ExternalLink_List[]) |
addigy_assetfieldmappings | array | Asset field mappings (IntegrationFieldMapping[]) |
addigy_deactivate_assets | boolean | Deactivate removed assets |
addigy_import_entities | string | Entities to import (comma-separated) |
halointegrator_addigy | boolean | Enable HaloIntegrator sync |
halointegrator_addigy_lastsync | datetime | Last successful sync |
halointegrator_addigy_lasterror | string | Last sync error |
addigy_apiversion | integer | Addigy API version |
Raynet / RaynetDetails
GET /Raynet/Get — Retrieve live data from Raynet.
RaynetDetails follows the standard CRUD pattern.
RaynetDetails Schema (key fields)
| Field | Type | Description |
|---|---|---|
id | integer | Record ID |
name | string | Integration name |
url | string | Raynet server URL |
new_integration_key | string | API key (write-only) |
default_devicesite | integer | Default site for imported assets |
default_devicetype | integer | Default asset type |
assetimportidentifier | integer | Asset matching identifier field |
fieldmappings | array | Asset field mappings (IntegrationFieldMapping[]) |
site_rules | array | Site matching rules (IntegrationSiteMapping[]) |
site_mappings | array | Site link mappings (ExternalLink_List[]) |
enableintegrator | boolean | Enable HaloIntegrator sync |
lastsyncdate | datetime | Last successful sync |
lastsyncerror | string | Last sync error |
delete_devices | boolean | Remove devices not found in Raynet |
dont_create_new_devices | boolean | Skip creating new assets |
default_status | integer | Default asset status on import |
delete_status | integer | Status to apply when asset removed |
site_matching_method | integer | Algorithm for matching sites |
halo_integrator_import_types | array | Types to import (KeyPair2[]) |
GoToResolve
GoTo Resolve remote support integration.
| Method | Path | Description |
|---|---|---|
GET | /GoToResolve/Complete | Mark a GoTo Resolve session as complete |
GET | /GoToResolve/Download | Download GoTo Resolve session data |
ISLOnline
ISL Online remote support integration.
| Method | Path | Description |
|---|---|---|
GET | /ISLOnline/Get | Retrieve ISL Online configuration/data |
POST | /ISLOnline/CreateLink | Create a remote support link. Body: Device (device record to connect to) |
Device Schema (key fields used for ISL Online link creation)
| Field | Type | Description |
|---|---|---|
id | integer | Device/asset record ID |
client_id | integer | Associated client ID |
site_id | integer | Associated site ID |
key_field | string | Primary identifying field value |
TakeControl
SolarWinds Take Control (previously BeanstalkRemote) integration.
| Method | Path | Description |
|---|---|---|
GET | /TakeControl/GetUrl | Get 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
| Method | Path | Description |
|---|---|---|
GET | /RemoteSession | List remote session records. Requires authentication. |
POST | /RemoteSession | Create 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
| Parameter | Type | Description |
|---|---|---|
agent | string | Filter by agent name |
agent_id | integer | Filter by agent ID |
client_id | integer | Filter by client ID |
site_id | integer | Filter by site ID |
username | string | Filter by end-user username |
count | integer | Limit number of results |
page_no | integer | Page number for pagination |
page_size | integer | Records per page |
pageinate | boolean | Enable pagination |
search | string | Text search across session records |
order | string | Primary sort field |
order2–order5 | string | Secondary sort fields |
orderdesc–orderdesc5 | boolean | Sort descending for each order field |
includelinked | boolean | Include linked records |
RemoteSessionData Schema
| Field | Type | Description |
|---|---|---|
id | integer | Session record ID |
thirdpartyid | string | Session ID from the remote tool |
ticket_id | integer | Linked ticket ID |
actionnumber | integer | Linked ticket action number |
calllogid | integer | Linked call log ID |
customername | string | Customer/client name |
sitename | string | Site name |
username | string | End-user name |
emailaddress | string | End-user email |
sessionstate | integer | Current session state |
sessionfinished | boolean | Whether session has ended |
queuedate | datetime | Time session entered queue |
leftqueuedate | datetime | Time session left queue |
sessionstartdate | datetime | Session start time |
sessionenddate | datetime | Session end time |
matchedclient | integer | Matched Halo client ID |
matchedsite | integer | Matched Halo site ID |
matcheduser | string | Matched Halo user |
outcome | integer | Session outcome code |
phonenumber | string | End-user phone number |
notes | string | Session notes |
summary | string | Session summary |
resolved | boolean | Whether session resolved the issue |
isnewreq | boolean | Whether session generated a new ticket |
userid | integer | Halo user ID |
clientid | integer | Halo client ID |
siteid | integer | Halo site ID |
time_taken | number | Session duration (hours) |
agent_url | string | Agent-side session URL |
recording_url | string | Recording URL (if session was recorded) |
module_id | integer | Source module/integration ID |
RemoteSessionTeams
Microsoft Teams-based remote session configuration.
| Method | Path | Description |
|---|---|---|
GET | /RemoteSessionTeams | List Teams remote session configurations |
GET /RemoteSessionTeams Query Parameters
| Parameter | Type | Description |
|---|---|---|
includeenabled | boolean | Filter to only enabled Teams configurations |
msid | string | Filter by Microsoft tenant/object ID |