Skip to content

Instantly share code, notes, and snippets.

@homotechsual

homotechsual/NinjaOne.oa3.json

Created July 12, 2022 20:46
Show Gist options
  • Save homotechsual/e32d9c815c62b41501dc7d049fbd06f5 to your computer and use it in GitHub Desktop.
Save homotechsual/e32d9c815c62b41501dc7d049fbd06f5 to your computer and use it in GitHub Desktop.
Download ZIP
NinjaOne API Spec
Raw
NinjaOne.oa3.json
This file has been truncated, but you can view the full file.
{
"openapi": "3.0.1",
"info": {
"title": "Ninja RMM Public API 2.0",
"description": "Ninja RMM Public API documentation. <br /><br />\nSee also: <br /> \n<a href=\"https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf\">Device Filter syntax</a><br />\n<a href=\"https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Webhooks.pdf\">Webhooks</a>",
"contact": { "email": "[email protected]" },
"version": "2.0.9-draft"
},
"servers": [
{
"url": "https://eu.ninjarmm.com",
"description": "EU instance"
},
{
"url": "https://app.ninjarmm.com",
"description": "US instance"
},
{
"url": "https://oc.ninjarmm.com",
"description": "Oceania instance"
}
],
"security": [
{ "oauth2": ["monitoring", "Management", "control"] },
{ "sessionKey": ["monitoring", "Management", "control"] },
{ "bearer": ["monitoring", "Management", "control"] }
],
"tags": [
{ "name": "System", "description": "Core system Entities and Resources", "x-displayName": "System" },
{ "name": "Organization", "description": "Organizations", "x-displayName": "Organizations" },
{ "name": "Devices", "description": "Devices" , "x-displayName": "Devices" },
{ "name": "Groups", "description": "Groups/Search", "x-displayName": "Groups" },
{ "name": "Queries", "description": "Queries", "x-displayName": "Queries" },
{ "name": "Management", "description": "Management", "x-displayName": "Management" },
{ "name": "Ticketing", "description": "Ticketing", "x-displayName": "Ticketing" }
],
"paths": {
"/api/v2/alert/{uid}": {
"delete": {
"tags": ["Management"],
"summary": "Reset alert/condition",
"description": "Resets an alert/condition specified with an alert UID.**PowerShell commandlet:** [Reset-NinjaOneAlert](/modules/ninjaone/reset/reset-ninjaonealert)",
"operationId": "resetAlert",
"security": [
{ "bearer": ["Management"] },
{ "sessionKey": ["Management"] },
{ "oauth2": ["Management"] }
],
"parameters": [
{
"name": "uid",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid" },
"example": "f8c6f8c6-f8c6-f8c6-f8c6-f8c6f8c6f8c6"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/GenericSuccess"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
},
"/api/v2/organizations": {
"get": {
"tags": ["Organization"],
"summary": "List organizations",
"description": "Returns list of organizations (Brief mode)",
"operationId": "getOrganizations",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "Limit number of organizations to return",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "after",
"in": "query",
"description": "Last Organization Identifier from previous page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
},
"x-codeSamples": [
{
"lang": "Bash",
"source": "curl -X GET https://eu.ninjarmm.com/api/v2/organizations -H 'authorization: Bearer <token>'"
},
{
"lang": "PowerShell",
"source": "Invoke-WebRequest -Method GET -Uri https://eu.ninjarmm.com/api/v2/organizations -Headers @{ 'authorization' = 'Bearer <token>' } -ContentType 'application/json'"
},
{
"lang": "NinjaOne Module",
"source": "Get-NinjaOneOrganisations"
}
]
},
"post": {
"tags": ["Organization"],
"summary": "Create new organization",
"description": "Creates new organization with optional list of locations and policy mappings.\nTemplate organization ID can be specified to copy various settings",
"operationId": "createOrganization",
"parameters": [
{
"name": "templateOrganizationId",
"in": "query",
"schema": {
"type": "integer",
"description": "Model/Template organization to copy settings from",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDetailed"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": { "type": "string", "description": "Organization Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locations": {
"type": "array",
"description": "List of locations",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
}
},
"policies": {
"type": "array",
"description": "Node role policy assignments",
"items": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Policy Identifier",
"format": "int32"
}
},
"description": "Node role policy assignments"
}
},
"settings": {
"$ref": "#/components/schemas/OrganizationSettings"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
}
}
}
},
"/api/v2/webhook": {
"put": {
"tags": ["Management"],
"summary": "API Webhook configuration",
"description": "Creates or updates Webhook configuration for current application/client",
"operationId": "configureWebhook",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookConfiguration"
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/GenericSuccess"
}
}
},
"delete": {
"tags": ["Management"],
"summary": "Remove Webhook API channel",
"description": "Creates or updates PSA configuration based on client",
"operationId": "disableWebhook",
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/devices/approval/{mode}": {
"post": {
"tags": ["Management"],
"summary": "Approve/Reject devices",
"description": "Approve or reject devices that are waiting for approval",
"operationId": "nodeApprovalOperation",
"parameters": [
{
"name": "mode",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Approval action to perform",
"enum": ["APPROVE", "REJECT"]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"devices": { "type": "array", "items": { "type": "integer", "format": "int32" } }
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/GenericSuccess"
}
}
}
},
"/api/v2/alert/{uid}/reset": {
"post": {
"tags": ["Management"],
"summary": "Reset alert/condition and provide custom data for activity",
"description": "Resets alert/condition by UID",
"operationId": "resetAlertSetActivityData",
"parameters": [
{
"name": "uid",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid" }
}
],
"requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } },
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/ticketing/ticket/{ticketId}": {
"put": {
"tags": ["Management"],
"summary": "modify ticket",
"description": "modify ticket",
"operationId": "update",
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ticket": {
"type": "object",
"properties": {
"requestUid": { "type": "string", "format": "uuid" },
"version": { "type": "integer", "format": "int32" },
"clientId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"nodeId": { "type": "integer", "format": "int32" },
"summary": { "maxLength": 200, "minLength": 0, "type": "string" },
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": {
"type": "string",
"enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"]
},
"assignedAppUserId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
}
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"value": { "type": "string" }
}
}
},
"severity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"tags": { "type": "array", "items": { "type": "string" } },
"parentTicketId": { "type": "integer", "format": "int32" }
}
},
"comment": {
"type": "object",
"properties": {
"public": { "type": "boolean" },
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"uploads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": { "type": "string" },
"metadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
}
}
}
},
"timeTracked": { "type": "integer", "format": "int32" },
"duplicateInIncidents": { "type": "boolean" }
}
}
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"version": { "type": "integer", "format": "int32" },
"emailId": { "type": "string" },
"emailAddressConfigId": { "type": "integer", "format": "int32" },
"assignedAppUserId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"nodeId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"clientId": { "type": "integer", "format": "int32" },
"summary": { "type": "string" },
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": {
"type": "string",
"enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"]
},
"source": {
"type": "string",
"enum": [
"TECHNICIAN",
"EMAIL",
"WEB_FORM",
"HELP_REQUEST",
"END_USER",
"CONDITION",
"SCHEDULED_SCRIPT"
]
},
"sourceConfigUid": { "type": "string", "format": "uuid" },
"priority": { "type": "integer", "format": "int32" },
"severity": { "type": "integer", "format": "int32" },
"createTime": { "type": "number", "format": "double" },
"deleted": { "type": "boolean" },
"tags": { "type": "array", "items": { "type": "string" } },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
}
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"textValue": { "type": "string" },
"encryptedTextValue": { "type": "string" },
"intValue": { "type": "integer", "format": "int32" },
"floatValue": { "type": "number", "format": "float" },
"datetimeValue": { "type": "number", "format": "double" },
"uuidValue": { "type": "string", "format": "uuid" },
"booleanValue": { "type": "boolean" },
"uuidValues": {
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"attachmentValue": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
},
"entityValue": {
"type": "object",
"properties": {
"entityId": { "type": "integer", "format": "int32" },
"type": {
"type": "string",
"enum": ["NODE", "CLIENT", "CLIENT_LOCATION"]
}
}
},
"entityValues": {
"type": "object",
"properties": {
"entityIds": {
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"type": {
"type": "string",
"enum": ["NODE", "CLIENT", "CLIENT_LOCATION"]
}
}
},
"wysiwygValue": {
"type": "object",
"properties": {
"text": { "type": "string" },
"html": { "type": "string" },
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
}
}
}
},
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"updatedBy": {
"type": "object",
"properties": {
"source": { "type": "string", "enum": ["API", "USER", "SCRIPT"] },
"user": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" }
}
}
},
"description": "Value source (who/what updated the value)"
},
"value": { "type": "object" }
}
}
},
"ticketForm": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"description": { "type": "string" },
"endUserTitle": { "type": "string" },
"content": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"timerSettings": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"mode": { "type": "string", "enum": ["MANUAL", "AUTO_START"] }
}
}
}
},
"active": { "type": "boolean" },
"default": { "type": "boolean" },
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"endUserVisible": { "type": "boolean" },
"endUserDefault": { "type": "boolean" },
"mode": {
"type": "string",
"writeOnly": true,
"enum": ["MANUAL", "AUTO_START"]
}
}
},
"requester": {
"type": "object",
"properties": {
"uid": { "type": "string", "format": "uuid" },
"clientId": { "type": "integer", "format": "int32" },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"email": { "type": "string" },
"deleted": { "type": "boolean" },
"userType": {
"type": "string",
"enum": ["TECHNICIAN", "END_USER", "CONTACT"]
},
"appUser": { "type": "boolean" }
}
},
"assignedAppUser": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"email": { "type": "string" },
"phone": { "type": "string" },
"phoneVerified": { "type": "boolean", "writeOnly": true },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"password": { "type": "string" },
"mustChangePw": { "type": "boolean" },
"enabled": { "type": "boolean" },
"contentNode": { "type": "object", "additionalProperties": true },
"ninjaAdmin": { "type": "boolean" },
"sysadmin": { "type": "boolean" },
"permitAllClients": { "type": "boolean" },
"notifyAllClients": { "type": "boolean" },
"masterMspUser": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER"] },
"clientId": { "type": "integer", "format": "int32" },
"favorites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
}
},
"recents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
}
},
"authenticationType": { "type": "string", "enum": ["NATIVE", "SSO"] },
"roleIds": {
"uniqueItems": true,
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"ownerRoleId": { "type": "integer", "format": "int32" },
"appUserClientMap": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"permit": { "type": "boolean" },
"notify": { "type": "boolean" }
}
}
},
"fileFolderBackupAllowed": { "type": "boolean" },
"emailNotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": {
"type": "string",
"enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
},
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
},
"u2FTokenCount": { "type": "integer", "format": "int32" },
"pwResetTime": { "type": "number", "format": "double" },
"invitationAcceptedTime": { "type": "number", "format": "double" },
"name": { "type": "string" },
"displayName": { "type": "string" },
"ticketingAdmin": { "type": "boolean" },
"phoneMasked": { "type": "string" },
"smsotpconfigured": { "type": "boolean" },
"totpconfigured": { "type": "boolean" },
"u2FConfigured": { "type": "boolean" },
"plainPassword": { "type": "string", "writeOnly": true },
"emailFormatLegacy": { "type": "boolean" },
"mfaconfigured": { "type": "boolean" },
"invitationAccepted": { "type": "boolean" },
"globalEndUser": { "type": "boolean" },
"technician": { "type": "boolean" },
"endUser": { "type": "boolean" },
"divisionContext": { "$ref": "#/components/schemas/IDivisionContext" },
"preferredMFAType": {
"type": "string",
"enum": ["NONE", "TOTP", "SMSOTP", "U2F_TOKEN"]
},
"smsnotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": {
"type": "string",
"enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
},
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
}
}
},
"client": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"name": { "type": "string" },
"description": { "type": "string" },
"psaId": { "type": "integer", "format": "int64" },
"psaName": { "type": "string" },
"folderUid": { "type": "string", "format": "uuid" },
"inHouse": { "type": "boolean" },
"contentNode": { "type": "object", "additionalProperties": true },
"defaultLocationId": { "type": "integer", "format": "int32" },
"userData": { "type": "object", "additionalProperties": true },
"remoteSupportFolder": { "type": "boolean" },
"clientPolicyList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"policyId": { "type": "integer", "format": "int32" }
}
}
},
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"credentialsMap": {
"type": "object",
"additionalProperties": { "type": "integer", "format": "int32" }
},
"approvalMode": {
"type": "string",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"valid": { "type": "boolean" },
"content": { "type": "string" },
"connectWiseNode": { "type": "object", "additionalProperties": true },
"psaIdAsInt": { "type": "integer", "format": "int32" },
"productCode": {
"type": "string",
"enum": [
"SHADOWPROTECT",
"IMAGEMANAGER",
"VIPRE",
"SPLASHTOP",
"CLOUDBERRY",
"WEBROOT",
"BITDEFENDER",
"LOCKHART",
"CONNECTWISE"
]
},
"validForPsaTicketCreate": { "type": "boolean" }
}
},
"location": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"address": { "type": "string" },
"description": { "type": "string" },
"userData": { "type": "object", "additionalProperties": true },
"psaLocationId": { "type": "integer", "format": "int32" },
"psaLocationName": { "type": "string" },
"clientId": { "type": "integer", "format": "int32" },
"default": { "type": "boolean" },
"locationContent": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
},
"networkLocationEnabled": { "type": "boolean" },
"content": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
}
}
},
"node": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"nodeRole": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
},
"clientId": { "type": "integer", "format": "int32" },
"policyId": { "type": "integer", "format": "int32" },
"dnsName": { "type": "string" },
"systemName": { "type": "string" },
"netbiosName": { "type": "string" },
"friendlyName": { "type": "string" },
"ipAddress": {
"type": "object",
"properties": {
"canonicalHostName": { "type": "string" },
"multicastAddress": { "type": "boolean" },
"anyLocalAddress": { "type": "boolean" },
"loopbackAddress": { "type": "boolean" },
"linkLocalAddress": { "type": "boolean" },
"siteLocalAddress": { "type": "boolean" },
"mcglobal": { "type": "boolean" },
"mcnodeLocal": { "type": "boolean" },
"mclinkLocal": { "type": "boolean" },
"mcsiteLocal": { "type": "boolean" },
"mcorgLocal": { "type": "boolean" },
"address": {
"type": "array",
"items": { "type": "string", "format": "byte" }
},
"hostAddress": { "type": "string" },
"hostName": { "type": "string" }
}
},
"nodeType": {
"type": "string",
"enum": [
"AGENT",
"CLOUD_MONITOR_TARGET",
"NMS_SERVER",
"NMS_TARGET",
"VMM_TARGET",
"CLOUD_MONITOR_TARGET_EMAIL_SERVER",
"MOBILE_TARGET"
]
},
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"chassisType": {
"type": "string",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"submitTime": { "type": "number", "format": "double" },
"contactTime": { "type": "number", "format": "double" },
"offline": { "type": "boolean" },
"parentNodeId": { "type": "integer", "format": "int32" },
"onlineStatus": {
"type": "string",
"enum": [
"OFFLINE",
"ONLINE",
"CONNECTED",
"SLEEPING",
"UPGRADING",
"REBOOTING"
]
},
"locationId": { "type": "integer", "format": "int32" },
"created": { "type": "number", "format": "double" },
"description": { "type": "string" },
"approvalStatus": { "type": "string", "enum": ["PENDING", "APPROVED"] },
"responsibilities": {
"type": "array",
"items": {
"type": "string",
"enum": ["RMM_AGENT", "VMM_AGENT", "NM_AGENT"]
}
},
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"client": { "$ref": "#/components/schemas/Client" },
"needsReload": { "type": "boolean", "writeOnly": true },
"machineId": { "type": "string" },
"content": { "type": "string" },
"policyContent": { "type": "string" },
"agentSettings": { "type": "string" },
"monitorServerSettings": { "type": "string" },
"nmsServerSettings": { "type": "string" },
"offlineEvaluationStatus": {
"type": "string",
"enum": ["NOT_APPLICABLE", "PENDING", "PROCESSING", "COMPLETE_TRIGGERED"]
},
"approvalStatusByAppUserId": { "type": "integer", "format": "int32" },
"approvalStatusByAppUserName": { "type": "string" },
"approvalStatusTime": { "type": "number", "format": "double" },
"userData": { "type": "object", "additionalProperties": true },
"nodeMaintenanceInfo": {
"type": "object",
"properties": {
"startTime": { "type": "number", "format": "double" },
"endTime": { "type": "number", "format": "double" },
"agentMaintenanceStatus": {
"type": "string",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED_TO_ENTER_MAINTENANCE"]
},
"disabledOptions": { "type": "array", "items": { "type": "string" } }
}
},
"isWAMPRegistered": { "type": "boolean" },
"currentSessionId": { "type": "string", "format": "uuid" },
"publicIP": { "type": "string" },
"credentialsMap": {
"type": "object",
"additionalProperties": { "type": "integer", "format": "int32" }
},
"mdmStatus": {
"type": "string",
"enum": ["PENDING_RELINQUISH", "PENDING_ERASE", "RELINQUISHED", "ERASED"]
},
"name": { "type": "string" },
"disconnectedFromWAMP": { "type": "boolean" },
"connectedToWAMP": { "type": "boolean" },
"agentNode": { "type": "boolean" },
"allAncestors": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/Node" }
},
"parentNode": { "$ref": "#/components/schemas/Node" },
"clientUid": { "type": "string", "format": "uuid" },
"divisionUid": { "type": "string", "format": "uuid" },
"submitDataTeamViewerClientIdParsed": { "type": "boolean" },
"submitDataTeamViewerClientId": { "type": "integer", "format": "int32" },
"displayName": { "type": "string" },
"server": { "type": "boolean" },
"mdmDevice": { "type": "boolean" },
"windowsServer": { "type": "boolean" },
"windowsWorkstation": { "type": "boolean" },
"windowsDesktop": { "type": "boolean" },
"windowsLaptop": { "type": "boolean" },
"nmsServerNode": { "type": "boolean" },
"nmsTargetNode": { "type": "boolean" },
"nmsNode": { "type": "boolean" },
"macServer": { "type": "boolean" },
"macWorkstation": { "type": "boolean" },
"macDesktop": { "type": "boolean" },
"macLaptop": { "type": "boolean" },
"vmwareHost": { "type": "boolean" },
"vmwareVirtualMachine": { "type": "boolean" },
"hyperVHost": { "type": "boolean" },
"hyperVVirtualMachine": { "type": "boolean" },
"linuxServer": { "type": "boolean" },
"androidDevice": { "type": "boolean" },
"linuxWorkstation": { "type": "boolean" },
"linuxDesktop": { "type": "boolean" },
"linuxLaptop": { "type": "boolean" },
"dashboardString": { "type": "string" },
"approved": { "type": "boolean" },
"monitorServerNode": { "type": "boolean" },
"nodeRoleFields": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
}
},
"ticketRelationsByTicketRight": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/TicketRelation" }
},
"ticketRelationsByTicketLeft": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/TicketRelation" }
},
"solved": { "type": "boolean" },
"notModifiable": { "type": "boolean" }
}
}
}
}
}
}
}
},
"/api/v2/ticketing/ticket": {
"post": {
"tags": ["Management"],
"summary": "create ticket",
"description": "create ticket",
"operationId": "create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requestUid": { "type": "string", "format": "uuid" },
"clientId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"nodeId": { "type": "integer", "format": "int32" },
"summary": { "maxLength": 200, "minLength": 0, "type": "string" },
"description": {
"type": "object",
"properties": {
"public": { "type": "boolean" },
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"uploads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": { "type": "string" },
"metadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
}
}
}
},
"timeTracked": { "type": "integer", "format": "int32" },
"duplicateInIncidents": { "type": "boolean" }
}
},
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": { "type": "string", "enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"] },
"assignedAppUserId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
}
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"value": { "type": "string" }
}
}
},
"severity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"tags": { "type": "array", "items": { "type": "string" } },
"parentTicketId": { "type": "integer", "format": "int32" }
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": { "schema": { "type": "integer", "format": "int32" } }
}
}
}
}
},
"/api/v2/ticketing/ticket/{ticketId}/log-entry": {
"get": {
"tags": ["Ticketing"],
"summary": "Get list of ticket log entries",
"description": "Get list of ticket log entries",
"operationId": "getTicketLogEntriesByTicketId",
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"enum": ["DESCRIPTION", "COMMENT", "CONDITION", "SAVE", "DELETE"]
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"appUserContactUid": { "type": "string", "format": "uuid" },
"type": {
"type": "string",
"enum": ["DESCRIPTION", "COMMENT", "CONDITION", "SAVE", "DELETE"]
},
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"fullEmailBody": { "type": "string" },
"publicEntry": { "type": "boolean" },
"System": { "type": "boolean" },
"createTime": { "type": "number", "format": "double" },
"changeDiff": { "type": "object" },
"activityId": { "type": "integer", "format": "int64" },
"timeTracked": { "type": "integer", "format": "int32" },
"emailResponse": { "type": "boolean" }
}
}
}
}
}
}
}
}
},
"/api/v2/attachment/{id}": {
"get": {
"tags": ["System"],
"summary": "Retrieve attachment",
"description": "Returns attachment (image, document)",
"operationId": "getAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Attachment identifier",
"required": true,
"schema": { "type": "string" }
}
],
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/device/{id}": {
"get": {
"tags": ["Devices"],
"summary": "Device details",
"description": "Returns device details",
"operationId": "getDevice",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"200": {
"description": "Device information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
}
}
}
}
}
},
"patch": {
"tags": ["Management"],
"summary": "Update device information",
"description": "Change device friendly name, user data, etc.",
"operationId": "updateDevice",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Display name (User assigned)"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping, or reverts to organization policy if Null)",
"format": "int32"
}
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } },
"security": [{ "oauth2": ["Management"] }]
}
},
"/api/v2/device/{id}/windows-services": {
"get": {
"tags": ["Devices"],
"summary": "Windows services",
"description": "Returns list of Windows Services and their statuses",
"operationId": "getDeviceServices",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "name",
"in": "query",
"description": "Service name",
"schema": { "type": "string" }
},
{
"name": "state",
"in": "query",
"description": "Service state",
"schema": {
"type": "string",
"enum": [
"UNKNOWN",
"STOPPED",
"START_PENDING",
"RUNNING",
"STOP_PENDING",
"PAUSE_PENDING",
"PAUSED",
"CONTINUE_PENDING"
]
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"displayName": { "type": "string", "description": "Display Name" },
"description": { "type": "string", "description": "Description" },
"startType": {
"type": "string",
"description": "Start Type",
"enum": [
"AUTO_START",
"AUTO_START_DELAYED",
"BOOT_START",
"DEMAND_START",
"DISABLED",
"SYSTEM_START"
]
},
"userName": { "type": "string", "description": "User Name" },
"state": {
"type": "string",
"description": "State",
"enum": [
"UNKNOWN",
"STOPPED",
"START_PENDING",
"RUNNING",
"STOP_PENDING",
"PAUSE_PENDING",
"PAUSED",
"CONTINUE_PENDING"
]
}
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/dashboard-url": {
"get": {
"tags": ["Management"],
"summary": "Device link",
"description": "Returns link to device",
"operationId": "getDeviceLink",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "redirect",
"in": "query",
"description": "Return redirect response",
"schema": { "type": "boolean" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": { "type": "string", "description": "URL" },
"expires": {
"type": "number",
"description": "Link expiration time",
"format": "double"
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/policy/overrides": {
"get": {
"tags": ["Devices"],
"summary": "Get summary of device policy overrides",
"description": "Returns list of overridden policy sections",
"operationId": "getPolicyOverrides",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"overrides": {
"type": "array",
"description": "List of policy sections",
"items": { "type": "string", "description": "List of policy sections" }
}
}
}
}
}
}
}
},
"delete": {
"tags": ["Management"],
"summary": "Reset device policy overrides",
"description": "Submit request to remove device policy overrides",
"operationId": "resetPolicyOverrides",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": { "description": "default response", "content": { "application/json": {} } }
}
}
},
"/api/v2/device/{id}/scripting/options": {
"get": {
"tags": ["Management"],
"summary": "Device scripting options",
"description": "Returns scripting options (built-in actions, custom scripts) available for device",
"operationId": "requestScriptingOptions",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "lang",
"in": "query",
"description": "Language",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"internal": { "type": "boolean" }
}
}
},
"scripts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of script/action",
"enum": ["ACTION", "SCRIPT"]
},
"id": {
"type": "integer",
"description": "Custom script identifier (Scripts)",
"format": "int32"
},
"uid": {
"type": "string",
"description": "Built-in action identifier (Actions)",
"format": "uuid"
},
"name": { "type": "string", "description": "Name" },
"language": { "type": "string", "description": "Script language" },
"description": { "type": "string", "description": "Description" },
"architecture": {
"uniqueItems": true,
"type": "array",
"description": "Applicable architectures",
"items": { "type": "string", "description": "Applicable architectures" }
},
"categoryId": {
"type": "integer",
"description": "Script Category identifier",
"format": "int32"
}
}
}
},
"credentials": {
"type": "object",
"properties": {
"roles": { "type": "array", "items": { "type": "string" } },
"credentials": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"type": {
"type": "string",
"enum": [
"SNMPV12C",
"SNMPV3",
"TELNET_SSH",
"NETWORK_LOCATION",
"ENCRYPTION_KEY",
"BASIC"
]
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/windows-service/{serviceId}/control": {
"post": {
"tags": ["Management"],
"summary": "Windows service control",
"description": "Start/Stop/Restart Windows Service on a device",
"operationId": "controlWindowsService",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "serviceId",
"in": "path",
"description": "Service identifier",
"required": true,
"schema": { "type": "string" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Action",
"enum": ["START", "PAUSE", "STOP", "RESTART"]
}
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/device/{id}/reboot/{mode}": {
"post": {
"tags": ["Management"],
"summary": "Reboot device",
"description": "Sends a command to restart the computer",
"operationId": "rebootDevices",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "mode",
"in": "path",
"description": "Reboot mode",
"required": true,
"schema": { "type": "string", "enum": ["NORMAL", "FORCED"] }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reason": { "type": "string", "description": "Stated reboot reason" }
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/device/{id}/maintenance": {
"put": {
"tags": ["Management"],
"summary": "Schedule maintenance",
"description": "Schedule maintenance window for device",
"operationId": "updateDeviceMaintenance",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"disabledFeatures": {
"type": "array",
"description": "List of features that will be disabled during maintenance",
"items": {
"type": "string",
"description": "List of features that will be disabled during maintenance",
"enum": ["ALERTS", "PATCHING", "AVSCANS", "TASKS"]
}
},
"start": {
"type": "number",
"description": "Maintenance window start (optional, defaults to now)",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance window end",
"format": "double"
}
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
},
"delete": {
"tags": ["Management"],
"summary": "Cancel maintenance",
"description": "Cancel pending or active maintenance for device",
"operationId": "cancelDeviceMaintenance",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": { "description": "default response", "content": { "application/json": {} } }
}
}
},
"/api/v2/device/{id}/custom-fields": {
"get": {
"tags": ["Devices"],
"summary": "Device custom fields",
"description": "Returns list of applicable management options",
"operationId": "getNodeCustomFields",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": { "type": "object", "additionalProperties": { "type": "object" } }
}
}
}
}
},
"patch": {
"tags": ["Devices"],
"summary": "Update Field Values",
"description": "Update device custom field values",
"operationId": "updateNodeAttributeValues",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": { "type": "object", "additionalProperties": { "type": "object" } }
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/device/{id}/activities": {
"get": {
"tags": ["Devices"],
"summary": "Device activities",
"description": "Returns activity log for device",
"operationId": "getDeviceActivities",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "olderThan",
"in": "query",
"description": "Return activities recorded that are newer than specified activity ID",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "newerThan",
"in": "query",
"description": "Return activities recorded that are older than specified activity ID",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "activityType",
"in": "query",
"description": "Return activities of type",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Return activities with status(es)",
"schema": { "type": "string" }
},
{
"name": "seriesUid",
"in": "query",
"description": "Return activities related to alert (series)",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of activities to return",
"schema": {
"maximum": 1000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 200
}
},
{
"name": "lang",
"in": "query",
"description": "Language tag",
"schema": { "type": "string" }
},
{
"name": "tz",
"in": "query",
"description": "Time Zone",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lastActivityId": {
"type": "integer",
"description": "Last recorded activity ID for account",
"format": "int64"
},
"activities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Activity identifier",
"format": "int64"
},
"activityTime": {
"type": "number",
"description": "Activity timestamp",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"severity": {
"type": "string",
"description": "Severity",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": {
"type": "string",
"description": "Priority",
"enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
},
"seriesUid": {
"type": "string",
"description": "Activity series UID (job/condition UID)",
"format": "uuid"
},
"activityType": {
"type": "string",
"description": "Activity type code",
"enum": [
"ACTIONSET",
"ACTION",
"CONDITION",
"CONDITION_ACTIONSET",
"CONDITION_ACTION",
"ANTIVIRUS",
"PATCH_MANAGEMENT",
"TEAMVIEWER",
"MONITOR",
"SYSTEM",
"COMMENT",
"SHADOWPROTECT",
"IMAGEMANAGER",
"HELP_REQUEST",
"SOFTWARE_PATCH_MANAGEMENT",
"SPLASHTOP",
"CLOUDBERRY",
"CLOUDBERRY_BACKUP",
"SCHEDULED_TASK",
"RDP",
"SCRIPTING",
"SECURITY",
"REMOTE_TOOLS",
"VIRTUALIZATION",
"PSA",
"MDM"
]
},
"statusCode": {
"type": "string",
"description": "Activity status code",
"enum": [
"START_REQUESTED",
"STARTED",
"IN_PROCESS",
"COMPLETED",
"CANCEL_REQUESTED",
"CANCELLED",
"BLOCKED",
"TRIGGERED",
"RESET",
"ACKNOWLEDGED",
"DISABLED",
"EVALUATION_FAILURE",
"CLIENT_CREATED",
"CLIENT_UPDATED",
"CLIENT_DELETED",
"CREDENTIAL_CREATED",
"CREDENTIAL_UPDATED",
"CREDENTIAL_DELETED",
"LOCATION_CREATED",
"LOCATION_UPDATED",
"LOCATION_DELETED",
"POLICY_CREATED",
"POLICY_UPDATED",
"POLICY_DELETED",
"NODE_CREATED",
"NODE_UPDATED",
"NODE_DELETED",
"NODE_ACCESS_GRANTED",
"NODE_ACCESS_DENIED",
"NODE_REGISTRATION_REJECTED",
"NODE_IDENTIFICATION_UPDATED",
"NODE_CLONING_DETECTED",
"NODE_CLONE_ADVISED_TO_REGISTER",
"NODE_MANUALLY_APPROVED",
"NODE_AUTOMATICALLY_APPROVED",
"NODE_MANUALLY_REJECTED",
"NODE_AUTOMATICALLY_REJECTED",
"REJECTED_NODE_CLEARED",
"REJECTED_NODE_DELETED",
"MOBILE_DEVICE_UNREGISTERED",
"APP_USER_CREATED",
"APP_USER_UPDATED",
"APP_USER_DELETED",
"APP_USER_LOGGED_IN",
"APP_USER_LOGGED_OUT",
"APP_USER_MFA_SETUP",
"APP_USER_MFA_DELETED",
"APP_USER_CRITICAL_ACTION",
"APP_USER_AUDIT_FAILED_LOGIN",
"END_USER_CREATED",
"END_USER_UPDATED",
"END_USER_DELETED",
"END_USER_LOGGED_IN",
"END_USER_LOGGED_OUT",
"END_USER_MFA_SETUP",
"END_USER_MFA_DELETED",
"END_USER_AUDIT_FAILED_LOGIN",
"CONTACT_CREATED",
"CONTACT_UPDATED",
"CONTACT_DELETED",
"DEVICE_GROUP_CREATED",
"DEVICE_GROUP_UPDATED",
"DEVICE_GROUP_DELETED",
"TICKET_TEMPLATE_CREATED",
"TICKET_TEMPLATE_UPDATED",
"TICKET_TEMPLATE_DELETED",
"CUSTOM_HEALTH_STATUS_CHANGED",
"CUSTOM_HEALTH_STATUS_RESET",
"PSA_TICKET_CREATION_FAILED",
"PSA_TICKET_CREATION_SUCCEEDED",
"RESET_BY_PSA_TICKET_CALLBACK",
"PSA_TICKET_CREATION_TEST",
"PSA_ENABLED",
"PSA_DISABLED",
"PSA_CREDENTIALS_FAILED",
"CONNECTWISE_AGREEMENTS_SYNC_COMPLETED",
"CONNECTWISE_AGREEMENTS_SYNC_STARTED",
"CONNECTWISE_NODE_SYNC_COMPLETED",
"CONNECTWISE_NODE_SYNC_STARTED",
"CONNECTWISE_NODE_SYNC_NODE_CREATED",
"CONNECTWISE_NODE_SYNC_NODE_UPDATED",
"CONNECTWISE_NODE_SYNC_NODE_DELETED",
"CONNECTWISE_UPDATED",
"CONNECTWISECONTROL_ATTEMPT",
"AUTOTASK_NODE_SYNC_STARTED",
"AUTOTASK_NODE_SYNC_COMPLETED",
"AUTOTASK_NODE_SYNC_NODE_CREATED",
"AUTOTASK_NODE_SYNC_NODE_UPDATED",
"AUTOTASK_NODE_SYNC_NODE_DELETED",
"AUTOTASK_UPDATED",
"REPORT_CREATED",
"REPORT_UPDATED",
"REPORT_DELETED",
"TIME_ZONE_UPDATED",
"LANGUAGE_TAG_UPDATED",
"NODE_ROLE_CREATED",
"NODE_ROLE_UPDATED",
"NODE_ROLE_DELETED",
"COMMENT",
"VIPREAV_INSTALLED",
"VIPREAV_INSTALL_FAILED",
"VIPREAV_UNINSTALLED",
"VIPREAV_UNINSTALL_FAILED",
"VIPREAV_SCAN_THREAT_QUARANTINED",
"VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED",
"VIPREAV_USERINITIATED_THREAT_QUARANTINED",
"VIPREAV_QUARANTINED_THREAT_REMOVED",
"VIPREAV_REBOOT_REQUIRED",
"VIPREAV_SCAN_STARTED",
"VIPREAV_SCAN_COMPLETED",
"VIPREAV_SCAN_ABORTED",
"VIPREAV_SCAN_FAILED",
"VIPREAV_SCAN_PAUSED",
"VIPREAV_DISABLED",
"WEBROOT_COMMAND_SUBMITTED",
"WEBROOT_THREAT_DETECTED",
"WEBROOT_INSTALL_FAILED",
"BITDEFENDER_SCAN_STARTED",
"BITDEFENDER_SCAN_COMPLETED",
"BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE",
"BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE",
"BITDEFENDER_SCAN_FAILED",
"BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED",
"BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED",
"BITDEFENDER_DOWNLOAD_STARTED",
"BITDEFENDER_DOWNLOAD_SUCCEEDED",
"BITDEFENDER_DOWNLOAD_FAILED",
"BITDEFENDER_INSTALLATION_STARTED",
"BITDEFENDER_INSTALLATION_SUCCEEDED",
"BITDEFENDER_INSTALLATION_FAILED",
"BITDEFENDER_UNINSTALLATION_STARTED",
"BITDEFENDER_UNINSTALLATION_SUCCEEDED",
"BITDEFENDER_UNINSTALLATION_FAILED",
"BITDEFENDER_UNPACKING_FAILED",
"BDAS_BITDEFENDER_THREAT_IGNORED",
"BDAS_BITDEFENDER_THREAT_PRESENT",
"BDAS_BITDEFENDER_THREAT_DELETED",
"BDAS_BITDEFENDER_THREAT_BLOCKED",
"BDAS_BITDEFENDER_THREAT_QUARANTINED",
"BDAS_BITDEFENDER_THREAT_CLEANED",
"BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED",
"BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS",
"BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED",
"BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH",
"BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED",
"BITDEFENDER_RETRY_INSTALL_COMPLETED",
"BITDEFENDER_DISABLED",
"BITDEFENDER_EXISTING_PRODUCT_UNINSTALL",
"COMPETITOR_EXISTING_PRODUCT_UNINSTALL",
"SCHEDULE_INSTALL_OPTION_CHANGED",
"SECURITY_CREDENTIAL_ACCESS_GRANTED",
"SECURITY_CREDENTIAL_ACCESS_DENIED",
"PATCH_MANAGEMENT_SCAN_STARTED",
"PATCH_MANAGEMENT_SCAN_COMPLETED",
"PATCH_MANAGEMENT_APPLY_PATCH_STARTED",
"PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED",
"PATCH_MANAGEMENT_INSTALLED",
"PATCH_MANAGEMENT_INSTALL_FAILED",
"PATCH_MANAGEMENT_MESSAGE",
"PATCH_MANAGEMENT_FAILURE",
"SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED",
"SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED",
"SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED",
"SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED",
"SOFTWARE_PATCH_MANAGEMENT_INSTALLED",
"SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED",
"SOFTWARE_PATCH_MANAGEMENT_MESSAGE",
"TEAMVIEWER_INSTALLED",
"TEAMVIEWER_INSTALL_FAILED",
"TEAMVIEWER_UNINSTALLED",
"TEAMVIEWER_UNINSTALL_FAILED",
"TEAMVIEWER_CONNECTION_ESTABLISHED",
"TEAMVIEWER_CONNECTION_TERMINATED",
"TEAMVIEWER_PERMANENT_PASSWORD_CHANGED",
"TEAMVIEWER_ACCOUNTNAME_ADDED",
"TEAMVIEWER_ACCOUNTNAME_CHANGED",
"TEAMVIEWER_ACCOUNTNAME_REMOVED",
"TEAMVIEWER_CONNECTION_CANCELLED",
"TEAMVIEWER_CONFIG_CHANGED",
"SPLASHTOP_CONNECTION_INITIATED",
"SPLASHTOP_CONNECTION_ESTABLISHED",
"SPLASHTOP_CONNECTION_TERMINATED",
"REMOTE_TOOLS_UPLOAD_FILE_INITIATED",
"REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED",
"REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED",
"REMOTE_TOOLS_RENAME_FILE_INITIATED",
"REMOTE_TOOLS_DELETE_FILE_INITIATED",
"REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS",
"REMOTE_TOOLS_MODIFY_OBJECT_FAILED",
"REMOTE_TOOLS_COPY_OBJECT_SUCCESS",
"REMOTE_TOOLS_COPY_OBJECT_FAILED",
"REMOTE_TOOLS_MOVE_OBJECT_SUCCESS",
"REMOTE_TOOLS_MOVE_OBJECT_FAILED",
"REMOTE_TOOLS_DELETE_OBJECT_SUCCESS",
"REMOTE_TOOLS_DELETE_OBJECT_FAILED",
"REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS",
"REMOTE_TOOLS_CREATE_DIRECTORY_FAILED",
"REMOTE_TOOLS_FILE_TRANSFER_SUCCESS",
"REMOTE_TOOLS_FILE_TRANSFER_FAILED",
"REMOTE_TOOLS_SERVICE_CONTROL_INITIATED",
"REMOTE_TOOLS_START_SERVICE_SUCCESS",
"REMOTE_TOOLS_START_SERVICE_FAILED",
"REMOTE_TOOLS_STOP_SERVICE_SUCCESS",
"REMOTE_TOOLS_STOP_SERVICE_FAILED",
"REMOTE_TOOLS_RESTART_SERVICE_SUCCESS",
"REMOTE_TOOLS_RESTART_SERVICE_FAILED",
"REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS",
"REMOTE_TOOLS_START_TYPE_CHANGE_FAILED",
"REMOTE_TOOLS_PROCESS_CONTROL_INITIATED",
"REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS",
"REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED",
"REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS",
"REMOTE_TOOLS_TERMINATE_PROCESS_FAILED",
"REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS",
"REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED",
"REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED",
"REMOTE_TOOLS_CREATE_KEY_SUCCESS",
"REMOTE_TOOLS_CREATE_KEY_FAILED",
"REMOTE_TOOLS_RENAME_KEY_SUCCESS",
"REMOTE_TOOLS_RENAME_KEY_FAILED",
"REMOTE_TOOLS_DELETE_KEY_SUCCESS",
"REMOTE_TOOLS_DELETE_KEY_FAILED",
"REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS",
"REMOTE_TOOLS_CREATE_PARAMETER_FAILED",
"REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS",
"REMOTE_TOOLS_RENAME_PARAMETER_FAILED",
"REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS",
"REMOTE_TOOLS_DELETE_PARAMETER_FAILED",
"REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS",
"REMOTE_TOOLS_MODIFY_PARAMETER_FAILED",
"REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED",
"ADAPTER_ADDED",
"ADAPTER_REMOVED",
"ADAPTER_CONFIG_CHANGED",
"ADAPTER_STATUS_CHANGED",
"CPU_ADDED",
"CPU_REMOVED",
"MEMORY_ADDED",
"MEMORY_REMOVED",
"DISK_DRIVE_ADDED",
"DISK_DRIVE_REMOVED",
"USER_LOGGED_IN",
"USER_LOGGED_OUT",
"PORT_OPENED",
"PORT_CLOSED",
"WINDOWS_SERVICE_STARTED",
"WINDOWS_SERVICE_STOPPED",
"MAC_DAEMON_STARTED",
"MAC_DAEMON_STOPPED",
"USER_ACCOUNT_ADDED",
"USER_ACCOUNT_REMOVED",
"PROCESS_STARTED",
"PROCESS_STOPPED",
"SYSTEM_REBOOTED",
"SOFTWARE_ADDED",
"SOFTWARE_REMOVED",
"DISK_PARTITION_ADDED",
"DISK_PARTITION_REMOVED",
"DISK_VOLUME_ADDED",
"DISK_VOLUME_REMOVED",
"CREDENTIALS_CHANGED",
"RAID_CONTROLLER_ADDED",
"RAID_CONTROLLER_REMOVED",
"RAID_PHYSICAL_DRIVE_ADDED",
"RAID_PHYSICAL_DRIVE_REMOVED",
"RAID_LOGICAL_DISK_ADDED",
"RAID_LOGICAL_DISK_REMOVED",
"BITLOCKER_ENABLED",
"BITLOCKER_DISABLED",
"FILEVAULT_ENABLED",
"FILEVAULT_DISABLED",
"TRUSTED_PLATFORM_MODULE_ENABLED",
"TRUSTED_PLATFORM_MODULE_DISABLED",
"TRUSTED_PLATFORM_MODULE_INSTALLED",
"TRUSTED_PLATFORM_MODULE_UNINSTALLED",
"SERVER_MESSAGE",
"AGENT_MESSAGE",
"WEBAPP_MESSAGE",
"DIVISION_FEATURE_ENABLED",
"DIVISION_FEATURE_DISABLED",
"NODE_JOBS_CANCELLED",
"DIVISION_STATUS_CHANGED",
"SHADOWPROTECT_INSTALLED",
"SHADOWPROTECT_INSTALL_FAILED",
"SHADOWPROTECT_UNINSTALLED",
"SHADOWPROTECT_UNINSTALL_FAILED",
"SHADOWPROTECT_BACKUPJOB_FAILED",
"SHADOWPROTECT_BACKUPJOB_ABORTED",
"SHADOWPROTECT_LICENSE_PROVISIONED",
"SHADOWPROTECT_LICENSE_PROVISION_FAILED",
"SHADOWPROTECT_LICENSE_ACTIVATED",
"SHADOWPROTECT_LICENSE_ACTIVATION_FAILED",
"SHADOWPROTECT_LICENSE_DEACTIVATED",
"SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED",
"IMAGEMANAGER_INSTALLED",
"IMAGEMANAGER_INSTALL_FAILED",
"IMAGEMANAGER_UNINSTALLED",
"IMAGEMANAGER_UNINSTALL_FAILED",
"IMAGEMANAGER_LICENSE_PROVISIONED",
"IMAGEMANAGER_LICENSE_PROVISION_FAILED",
"IMAGEMANAGER_LICENSE_ACTIVATED",
"IMAGEMANAGER_LICENSE_ACTIVATION_FAILED",
"IMAGEMANAGER_LICENSE_DEACTIVATED",
"IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED",
"IMAGEMANAGER_CONSOLIDATION_FAILED",
"IMAGEMANAGER_VERIFICATION_FAILED",
"HELP_REQUEST_SUBMITTED",
"CLOUDBERRY_INSTALLED",
"CLOUDBERRY_INSTALL_FAILED",
"CLOUDBERRY_UNINSTALLED",
"CLOUDBERRY_UNINSTALL_FAILED",
"CLOUDBERRY_BACKUPPLAN_CREATED",
"CLOUDBERRY_BACKUPPLAN_EDITED",
"CLOUDBERRY_BACKUPPLAN_DELETED",
"CLOUDBERRY_BACKUPPLAN_CREATION_FAILED",
"CLOUDBERRY_BACKUPJOB_STARTED",
"CLOUDBERRY_BACKUPJOB_SUCCEEDED",
"CLOUDBERRY_BACKUPJOB_FAILED",
"CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING",
"CLOUDBERRY_USER_CREATED",
"CLOUDBERRY_NETWORK_CREDENTIAL_CREATED",
"CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED",
"RDP_CONNECTION_INITIATED",
"RDP_CONNECTION_ESTABLISHED",
"RDP_CONNECTION_TERMINATED",
"RDP_AUTO_PROVISION",
"NC_SESSION_REQUESTED",
"NC_SESSION_STARTED",
"NC_SESSION_TERMINATED",
"NC_SESSION_SESSION_TERMINATION_REQUESTED",
"NC_SESSION_FAILED_TO_START",
"SCHEDULED_TASK_CREATED",
"SCHEDULED_TASK_UPDATED",
"SCHEDULED_TASK_DELETED",
"SCRIPT_CREATED",
"SCRIPT_UPDATED",
"SCRIPT_DELETED",
"LOCKHART_BACKUPJOB_START_REQUESTED",
"LOCKHART_BACKUPJOB_STARTED",
"LOCKHART_BACKUPJOB_IN_PROCESS",
"LOCKHART_BACKUPJOB_COMPLETED",
"LOCKHART_BACKUPJOB_FAILED",
"LOCKHART_RESTOREJOB_START_REQUESTED",
"LOCKHART_RESTOREJOB_STARTED",
"LOCKHART_RESTOREJOB_IN_PROCESS",
"LOCKHART_RESTOREJOB_COMPLETED",
"LOCKHART_RESTOREJOB_FAILED",
"LOCKHART_BACKUPJOB_COMPLETED_WITH_WARNING",
"LOCKHART_BACKUP_DOWNLOADED",
"LOCKHART_BACKUPPLAN_ADDED",
"LOCKHART_BACKUPPLAN_EDITED",
"LOCKHART_BACKUPPLAN_DELETED",
"LOCKHART_BACKUPJOB_CANCELLED",
"LOCKHART_BACKUPJOB_PROCESSING",
"LOCKHART_INSTALL_FAILED",
"LOCKHART_UNINSTALL_FAILED",
"LOCKHART_INSTALLED",
"LOCKHART_UNINSTALLED",
"LOCKHART_RESTOREJOB_CANCELLED",
"LOCKHART_BACKUPPLAN_CREATION_FAILED",
"LOCKHART_BACKUP_CONFIGURE_FAILED",
"LOCKHART_FILE_DOWNLOAD",
"LOCKHART_FOLDER_DOWNLOAD",
"LOCKHART_UPSYNCJOB_PROCESSING",
"LOCKHART_UPSYNCJOB_IN_PROCESS",
"LOCKHART_UPSYNCJOB_STARTED",
"LOCKHART_UPSYNCJOB_COMPLETED",
"LOCKHART_UPSYNCJOB_CANCELLED",
"LOCKHART_UPSYNCJOB_FAILED",
"LOCKHART_BACKUP_NAS_ACCESS_FAILED",
"LOCKHART_IMAGE_RESTORE_STARTED",
"LOCKHART_IMAGE_RESTORE_COMPLETED",
"LOCKHART_IMAGE_RESTORE_FAILED",
"LOCKHART_IMAGE_DOWNLOAD_STARTED",
"LOCKHART_IMAGE_DOWNLOAD_COMPLETED",
"LOCKHART_IMAGE_DOWNLOAD_FAILED",
"LOCKHART_IMAGE_DOWNLOAD_FILE_STARTED",
"LOCKHART_IMAGE_DOWNLOAD_FILE_COMPLETED",
"LOCKHART_IMAGE_DOWNLOAD_FILE_FAILED",
"LOCKHART_IMAGE_MOUNT_COMPLETED",
"LOCKHART_IMAGE_MOUNT_FAILED",
"LOCKHART_IMAGE_DOWNLOAD_FOLDER_STARTED",
"LOCKHART_IMAGE_DOWNLOAD_FOLDER_COMPLETED",
"LOCKHART_IMAGE_DOWNLOAD_FOLDER_FAILED",
"LOCKHART_REVISIONS_DELETE_STARTED",
"LOCKHART_REVISIONS_DELETED",
"LOCKHART_REVISIONS_DELETE_FAILED",
"LOCKHART_FOLDERS_DELETED",
"LOCKHART_FILES_DELETED",
"LOCKHART_FILES_AND_FOLDERS_DELETED",
"API_ACCESS_GRANTED",
"API_ACCESS_DENIED",
"API_WEBHOOK_CONFIGURATION_UPDATED",
"API_ACCESS_REVOKED",
"MAINTENANCE_MODE_CONFIGURED",
"MAINTENANCE_MODE_DELETED",
"MAINTENANCE_MODE_MODIFIED",
"MAINTENANCE_MODE_FAILED",
"REMOTE_SUPPORT_CREATED",
"REMOTE_SUPPORT_UPDATED",
"REMOTE_SUPPORT_DELETED",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_AND_SET_PRIMARY_GROUP_FAILED",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_AND_SET_PRIMARY_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_FAILED",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_ALLOW_USER_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_ALLOW_USER_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_DISABLED_ACCOUNT_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_DISABLED_ACCOUNT_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_DISABLED_PASSWORD_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_DISABLED_PASSWORD_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_DISABLE_USER_FAILED",
"ACTIVE_DIRECTORY_DISABLE_USER_SUCCESS",
"ACTIVE_DIRECTORY_DISALLOW_USER_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_DISALLOW_USER_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_ENABLE_USER_FAILED",
"ACTIVE_DIRECTORY_ENABLE_USER_SUCCESS",
"ACTIVE_DIRECTORY_ENABLED_PASSWORD_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_ENABLED_PASSWORD_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_NOT_REQUIRE_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_NOT_REQUIRE_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_REMOVE_USER_FROM_GROUP_FAILED",
"ACTIVE_DIRECTORY_REMOVE_USER_FROM_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_REQUIRE_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_REQUIRE_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_RESET_PASSWORD_FAILED",
"ACTIVE_DIRECTORY_RESET_PASSWORD_SUCCESS",
"ACTIVE_DIRECTORY_SET_ACCOUNT_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_SET_ACCOUNT_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_SET_PRIMARY_GROUP_FAILED",
"ACTIVE_DIRECTORY_SET_PRIMARY_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_UNLOCK_USER_SUCCESS",
"ACTIVE_DIRECTORY_UNLOCK_USER_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_JOB_RESULT_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_JOB_RESULT_SUCCESS",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DEPLOYMENT_RESULT",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CHANGE_CANDIDATE_NODE_STATUS_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CHANGE_CANDIDATE_NODE_STATUS_SUCCESS",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CLEAR_CANDIDATE_NODES_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CLEAR_CANDIDATE_NODES_SUCCESS",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DISCOVERY_JOB_CREATED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DISCOVERY_JOB_UPDATED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DISCOVERY_JOB_DELETED",
"UNKNOWN",
"NINJA_TICKETING_CREATION_FAILED",
"NINJA_TICKETING_FORM_CREATED",
"NINJA_TICKETING_FORM_UPDATED",
"NINJA_TICKETING_FORM_ACTIVED",
"NINJA_TICKETING_FORM_DEACTIVED",
"NINJA_TICKETING_ATTRIBUTE_CREATED",
"NINJA_TICKETING_ATTRIBUTE_UPDATED",
"NINJA_TICKETING_ATTRIBUTE_ACTIVED",
"NINJA_TICKETING_ATTRIBUTE_DEACTIVATED",
"NINJA_TICKETING_RULESET_CREATED",
"NINJA_TICKETING_RULESET_UPDATED",
"NINJA_TICKETING_RULESET_DELETED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT",
"NINJA_TICKETING_TRIGGER_CREATED",
"NINJA_TICKETING_TRIGGER_UPDATED",
"NINJA_TICKETING_TRIGGER_DELETED",
"NINJA_TICKETING_TICKET_CREATED",
"NINJA_TICKETING_TICKET_DELETED",
"NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED",
"NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED",
"NINJA_TICKETING_PENDING_EMAIL_REJECTED",
"NINJA_TICKETING_ENABLED",
"NINJA_TICKETING_DISABLED",
"NINJA_TICKETING_UPDATED",
"NINJA_TICKETING_FORM_MAKE_DEFAULT",
"NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT",
"NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT",
"NINJA_TICKETING_PENDING_EMAIL_RECEIVED",
"NODE_ATTRIBUTE_CREATED",
"NODE_ATTRIBUTE_UPDATED",
"NODE_ATTRIBUTE_DELETED",
"NODE_ATTRIBUTE_VALUE_UPDATED",
"NODE_ATTRIBUTE_VALUE_DECRYPTED",
"DOCUMENT_TEMPLATE_CREATED",
"DOCUMENT_TEMPLATE_UPDATED",
"DOCUMENT_TEMPLATE_DELETED",
"CLIENT_DOCUMENT_CREATED",
"CLIENT_DOCUMENT_UPDATED",
"CLIENT_DOCUMENT_DELETED",
"CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED",
"MDM_LOCK_DEVICE_STATUS_CREATED",
"MDM_REBOOT_DEVICE_STATUS_CREATED",
"MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED",
"MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED",
"MDM_LOCK_DEVICE_STATUS_UPDATED",
"MDM_REBOOT_DEVICE_STATUS_UPDATED",
"MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED",
"MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED",
"MDM_CLEAR_PASSCODE_STATUS_CREATED",
"MDM_CLEAR_PASSCODE_STATUS_UPDATED",
"MDM_ERASE_STATUS_CREATED",
"MDM_ERASE_STATUS_UPDATED"
]
},
"status": { "type": "string", "description": "Status description" },
"activityResult": {
"type": "string",
"description": "Activity result",
"enum": ["SUCCESS", "FAILURE", "UNSUPPORTED", "UNCOMPLETED"]
},
"sourceConfigUid": {
"type": "string",
"description": "Source configuration/policy element reference",
"format": "uuid"
},
"sourceName": {
"type": "string",
"description": "Source configuration/policy element name"
},
"subject": { "type": "string", "description": "Activity subject" },
"userId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"message": { "type": "string", "description": "Activity message" },
"type": { "type": "string", "description": "Activity type description" },
"data": {
"type": "object",
"additionalProperties": true,
"description": "Activity data"
}
}
}
},
"lastNodeActivityId": {
"type": "integer",
"description": "Last recorded activity ID for device",
"format": "int64"
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/disks": {
"get": {
"tags": ["Devices"],
"summary": "Device disk drives",
"description": "Returns device disks' details",
"operationId": "getDeviceDiskDrives",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bytesPerSector": {
"type": "integer",
"description": "Number of bytes per sector",
"format": "int32"
},
"description": { "type": "string", "description": "Description" },
"interfaceType": { "type": "string", "description": "Interface type" },
"manufacturer": { "type": "string", "description": "Manufacturer" },
"mediaType": { "type": "string", "description": "Media Type" },
"model": { "type": "string", "description": "Model" },
"name": { "type": "string", "description": "Name" },
"partitionCount": {
"type": "integer",
"description": "Number of partitions",
"format": "int32"
},
"serialNumber": { "type": "string", "description": "Serial number" },
"size": {
"type": "integer",
"description": "Size (Bytes)",
"format": "int64"
},
"smartCapable": {
"type": "boolean",
"description": "Is S.M.A.R.T. capable?"
},
"status": { "type": "string", "description": "Status" }
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/volumes": {
"get": {
"tags": ["Devices"],
"summary": "Device storage volumes",
"description": "Returns device volumes' details",
"operationId": "getDeviceVolumes",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "include",
"in": "query",
"description": "Additional information to include (bl - BitLocker status)",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"driveLetter": { "type": "string", "description": "Drive Letter" },
"label": { "type": "string", "description": "Volume Label" },
"deviceType": { "type": "string", "description": "Device Type" },
"fileSystem": { "type": "string", "description": "File System Type" },
"autoMount": { "type": "boolean", "description": "Automatically Mounted" },
"compressed": { "type": "boolean", "description": "Compressed" },
"capacity": {
"type": "integer",
"description": "Capacity (bytes)",
"format": "int64"
},
"freeSpace": {
"type": "integer",
"description": "Free Space (bytes)",
"format": "int64"
},
"serialNumber": { "type": "string", "description": "Serial Number" },
"bitLockerStatus": {
"type": "object",
"properties": {
"conversionStatus": {
"type": "string",
"description": "Volume encryption or decryption status.",
"enum": [
"FULLY_DECRYPTED",
"FULLY_ENCRYPTED",
"ENCRYPTION_IN_PROGRESS",
"DECRYPTION_IN_PROGRESS",
"ENCRYPTION_PAUSED",
"DECRYPTION_PAUSED",
"UNKNOWN"
]
},
"encryptionMethod": {
"type": "string",
"description": "Indicated the encryption algorithm and key size used on the volume",
"enum": [
"NONE",
"AES_128_WITH_DIFFUSER",
"AES_256_WITH_DIFFUSER",
"AES_128",
"AES_256",
"HARDWARE_ENCRYPTION",
"XTS_AES_128",
"XTS_AES_256",
"UNKNOWN"
]
},
"protectionStatus": {
"type": "string",
"description": " indicates whether the volume and its encryption key (if any) are secured.",
"enum": ["UNPROTECTED", "PROTECTED", "UNKNOWN", "PENDING"]
},
"lockStatus": {
"type": "string",
"description": "Indicates whether the contents of the volume are accessible from Windows",
"enum": ["UNKNOWN", "UNLOCKED", "LOCKED"]
},
"initializedForProtection": {
"type": "boolean",
"description": "Is initialized for protection"
}
},
"description": "BitLocker Status"
}
},
"description": "Disk Volumes"
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/processors": {
"get": {
"tags": ["Devices"],
"summary": "Device processors",
"description": "Returns list of device Processor details",
"operationId": "getDeviceProcessors",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"architecture": { "type": "string", "description": "Architecture" },
"maxClockSpeed": {
"type": "integer",
"description": "Max Clock Speed",
"format": "int64"
},
"clockSpeed": {
"type": "integer",
"description": "Current Clock Speed",
"format": "int64"
},
"name": { "type": "string", "description": "Name" },
"numCores": {
"type": "integer",
"description": "Number of Cores",
"format": "int32"
},
"numLogicalCores": {
"type": "integer",
"description": "Number of Logical Cores]",
"format": "int32"
}
},
"description": "Processors"
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/software": {
"get": {
"tags": ["Devices"],
"summary": "Device software inventory",
"description": "Returns list of software installed on device",
"operationId": "getDeviceSoftware",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"installDate": {
"type": "string",
"description": "Installation Date",
"format": "date-time"
},
"location": { "type": "string", "description": "Location" },
"name": { "type": "string", "description": "Product Name" },
"publisher": { "type": "string", "description": "Publisher" },
"size": {
"type": "integer",
"description": "Size on disk",
"format": "int64"
},
"version": { "type": "string", "description": "Version" },
"productCode": { "type": "string", "description": "Product Code" }
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/alerts": {
"get": {
"tags": ["Devices"],
"summary": "Device alerts (triggered conditions)",
"description": "Returns list of active alerts (triggered conditions) for device",
"operationId": "getDeviceAlerts",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "lang",
"in": "query",
"schema": { "type": "string", "description": "Language tag" }
},
{
"name": "tz",
"in": "query",
"description": "Time Zone",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "Alert UID (activity series UID)",
"format": "uuid"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"message": { "type": "string", "description": "Alert message" },
"createTime": {
"type": "number",
"description": "Alert creation timestamp",
"format": "double"
},
"updateTime": {
"type": "number",
"description": "Alert last updated",
"format": "double"
},
"sourceType": {
"type": "string",
"description": "Alert origin",
"enum": [
"AGENT_OFFLINE",
"CONDITION_AGENT_CPU",
"CONDITION_AGENT_MEMORY",
"CONDITION_AGENT_NETWORK",
"CONDITION_AGENT_DISK_IO",
"CONDITION_AGENT_DISK_FREE_SPACE",
"CONDITION_AGENT_DISK_USAGE",
"CONDITION_NMS_CPU",
"CONDITION_NMS_MEMORY",
"CONDITION_NMS_NETWORK_TRAFFIC_BITS",
"CONDITION_NMS_NETWORK_TRAFFIC_PERCENT",
"CONDITION_NMS_NETWORK_STATUS",
"CONDITION_NMS_NETWORK_STATUS_CHANGE",
"CONDITION_PING",
"CONDITION_PING_LATENCY",
"CONDITION_PING_PACKET_LOSS",
"CONDITION_PING_RESPONSE",
"CONDITION_SYSTEM_UPTIME",
"CONDITION_SMART_STATUS_DEGRATED",
"CONDITION_RAID_HEALTH_STATUS",
"CONDITION_SCRIPT_RESULT",
"CONDITION_HTTP",
"CONDITION_HTTP_RESPONSE",
"CONDITION_PORT",
"CONDITION_PORT_SCAN",
"CONDITION_SYSLOG",
"CONDITION_CONFIGURATION_FILE",
"CONDITION_SNMPTRAP",
"CONDITION_CRITICAL_EVENT",
"CONDITION_DNS",
"CONDITION_EMAIL",
"SHADOWPROTECT_BACKUPJOB_CREATE",
"SHADOWPROTECT_BACKUPJOB_UPDATE",
"SHADOWPROTECT_BACKUPJOB_DELETE",
"SHADOWPROTECT_BACKUPJOB_EXECUTE",
"IMAGEMANAGER_MANAGEDFOLDER_CREATE",
"IMAGEMANAGER_MANAGEDFOLDER_UPDATE",
"IMAGEMANAGER_MANAGEDFOLDER_DELETE",
"IMAGEMANAGER_MANAGEDFOLDER_EXECUTE",
"TEAMVIEWER_CONNECTION",
"RETRIEVE_AGENT_LOGS",
"SCHEDULED_TASK",
"CONDITION_WINDOWS_EVENT_LOG_TRIGGERED",
"CONDITION_WINDOWS_SERVICE_STATE_CHANGED",
"UI_MESSAGE_ACTION_REBOOT",
"UI_MESSAGE_BD_INSTALLATION_ISSUES",
"AV_QUARANTINE_THREAT",
"AV_RESTORE_THREAT",
"AV_DELETE_THREAT",
"AV_REMOVE_THREAT",
"BITDEFENDER_RESTORE_THREAT",
"BITDEFENDER_DELETE_THREAT",
"CONDITION_BITLOCKER_STATUS",
"CONDITION_FILEVAULT_STATUS",
"CONDITION_LINUX_PROCESS",
"CONDITION_LINUX_Daemon",
"CONDITION_LINUX_PROCESS_RESOURCE",
"CONDITION_LINUX_PROCESS_RESOURCE_CPU",
"CONDITION_LINUX_PROCESS_RESOURCE_MEMORY",
"CONDITION_LINUX_DISK_FREE_SPACE",
"CONDITION_LINUX_DISK_USAGE",
"CONDITION_VM_AGGREGATE_CPU_USAGE",
"CONDITION_VM_DISK_USAGE",
"CONDITION_VM_HOST_DATASTORE",
"CONDITION_VM_HOST_UPTIME",
"CONDITION_VM_HOST_DEVICE_DOWN",
"CONDITION_VM_HOST_BAD_SENSORS",
"CONDITION_VM_HOST_SENSOR_HEALTH",
"CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE",
"CONDITION_VM_GUEST_SNAPSHOT_SIZE",
"CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN",
"CONDITION_VM_GUEST_TOOLS_NOT_RUNNING",
"CONDITION_HV_GUEST_CHECKPOINT_SIZE",
"CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN",
"CONDITION_SOFTWARE",
"CONDITION_WINDOWS_PROCESS_STATE",
"CONDITION_WINDOWS_PROCESS_RESOURCE_CPU",
"CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_PROCESS_STATE",
"CONDITION_MAC_PROCESS_RESOURCE_CPU",
"CONDITION_MAC_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_DEAMON"
]
},
"sourceConfigUid": {
"type": "string",
"description": "Source configuration/policy element reference",
"format": "uuid"
},
"sourceName": {
"type": "string",
"description": "Source configuration/policy element name"
},
"subject": { "type": "string", "description": "Alert subject" },
"userId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"psaTicketId": {
"type": "integer",
"description": "Related PSA ticket ID",
"format": "int64"
},
"ticketTemplateId": {
"type": "integer",
"description": "PSA ticket template",
"format": "int32"
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Alert data"
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": {
"type": "number",
"description": "Created",
"format": "double"
},
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Organization full name"
},
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
}
},
"description": "Device information"
}
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/jobs": {
"get": {
"tags": ["Devices"],
"summary": "Device currently running (active) jobs",
"description": "Returns currently running jobs for device",
"operationId": "getDeviceActiveJobs",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "lang",
"in": "query",
"schema": { "type": "string", "description": "Language tag" }
},
{
"name": "tz",
"in": "query",
"description": "Time Zone",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "Task/Job UID (activity series UID)",
"format": "uuid"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"message": { "type": "string", "description": "Job message" },
"createTime": {
"type": "number",
"description": "Job start timestamp",
"format": "double"
},
"updateTime": {
"type": "number",
"description": "Job last updated",
"format": "double"
},
"sourceType": {
"type": "string",
"description": "Job origin",
"enum": [
"AGENT_OFFLINE",
"CONDITION_AGENT_CPU",
"CONDITION_AGENT_MEMORY",
"CONDITION_AGENT_NETWORK",
"CONDITION_AGENT_DISK_IO",
"CONDITION_AGENT_DISK_FREE_SPACE",
"CONDITION_AGENT_DISK_USAGE",
"CONDITION_NMS_CPU",
"CONDITION_NMS_MEMORY",
"CONDITION_NMS_NETWORK_TRAFFIC_BITS",
"CONDITION_NMS_NETWORK_TRAFFIC_PERCENT",
"CONDITION_NMS_NETWORK_STATUS",
"CONDITION_NMS_NETWORK_STATUS_CHANGE",
"CONDITION_PING",
"CONDITION_PING_LATENCY",
"CONDITION_PING_PACKET_LOSS",
"CONDITION_PING_RESPONSE",
"CONDITION_SYSTEM_UPTIME",
"CONDITION_SMART_STATUS_DEGRATED",
"CONDITION_RAID_HEALTH_STATUS",
"CONDITION_SCRIPT_RESULT",
"CONDITION_HTTP",
"CONDITION_HTTP_RESPONSE",
"CONDITION_PORT",
"CONDITION_PORT_SCAN",
"CONDITION_SYSLOG",
"CONDITION_CONFIGURATION_FILE",
"CONDITION_SNMPTRAP",
"CONDITION_CRITICAL_EVENT",
"CONDITION_DNS",
"CONDITION_EMAIL",
"SHADOWPROTECT_BACKUPJOB_CREATE",
"SHADOWPROTECT_BACKUPJOB_UPDATE",
"SHADOWPROTECT_BACKUPJOB_DELETE",
"SHADOWPROTECT_BACKUPJOB_EXECUTE",
"IMAGEMANAGER_MANAGEDFOLDER_CREATE",
"IMAGEMANAGER_MANAGEDFOLDER_UPDATE",
"IMAGEMANAGER_MANAGEDFOLDER_DELETE",
"IMAGEMANAGER_MANAGEDFOLDER_EXECUTE",
"TEAMVIEWER_CONNECTION",
"RETRIEVE_AGENT_LOGS",
"SCHEDULED_TASK",
"CONDITION_WINDOWS_EVENT_LOG_TRIGGERED",
"CONDITION_WINDOWS_SERVICE_STATE_CHANGED",
"UI_MESSAGE_ACTION_REBOOT",
"UI_MESSAGE_BD_INSTALLATION_ISSUES",
"AV_QUARANTINE_THREAT",
"AV_RESTORE_THREAT",
"AV_DELETE_THREAT",
"AV_REMOVE_THREAT",
"BITDEFENDER_RESTORE_THREAT",
"BITDEFENDER_DELETE_THREAT",
"CONDITION_BITLOCKER_STATUS",
"CONDITION_FILEVAULT_STATUS",
"CONDITION_LINUX_PROCESS",
"CONDITION_LINUX_Daemon",
"CONDITION_LINUX_PROCESS_RESOURCE",
"CONDITION_LINUX_PROCESS_RESOURCE_CPU",
"CONDITION_LINUX_PROCESS_RESOURCE_MEMORY",
"CONDITION_LINUX_DISK_FREE_SPACE",
"CONDITION_LINUX_DISK_USAGE",
"CONDITION_VM_AGGREGATE_CPU_USAGE",
"CONDITION_VM_DISK_USAGE",
"CONDITION_VM_HOST_DATASTORE",
"CONDITION_VM_HOST_UPTIME",
"CONDITION_VM_HOST_DEVICE_DOWN",
"CONDITION_VM_HOST_BAD_SENSORS",
"CONDITION_VM_HOST_SENSOR_HEALTH",
"CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE",
"CONDITION_VM_GUEST_SNAPSHOT_SIZE",
"CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN",
"CONDITION_VM_GUEST_TOOLS_NOT_RUNNING",
"CONDITION_HV_GUEST_CHECKPOINT_SIZE",
"CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN",
"CONDITION_SOFTWARE",
"CONDITION_WINDOWS_PROCESS_STATE",
"CONDITION_WINDOWS_PROCESS_RESOURCE_CPU",
"CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_PROCESS_STATE",
"CONDITION_MAC_PROCESS_RESOURCE_CPU",
"CONDITION_MAC_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_DEAMON"
]
},
"sourceConfigUid": {
"type": "string",
"description": "Source configuration/policy element reference",
"format": "uuid"
},
"sourceName": {
"type": "string",
"description": "Source configuration/policy element name"
},
"subject": { "type": "string", "description": "Job subject" },
"userId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"psaTicketId": {
"type": "integer",
"description": "Related PSA ticket ID",
"format": "int64"
},
"ticketTemplateId": {
"type": "integer",
"description": "PSA ticket template",
"format": "int32"
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Job data"
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": {
"type": "number",
"description": "Created",
"format": "double"
},
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Organization full name"
},
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
}
},
"description": "Device information"
},
"jobStatus": {
"type": "string",
"description": "Job Status",
"enum": [
"START_REQUESTED",
"STARTED",
"IN_PROCESS",
"COMPLETED",
"CANCEL_REQUESTED",
"CANCELLED",
"TRIGGERED",
"RESET",
"ACKNOWLEDGED",
"DISABLED"
]
},
"jobResult": {
"type": "string",
"description": "Job result",
"enum": ["SUCCESS", "FAILURE", "UNSUPPORTED", "UNCOMPLETED"]
},
"jobType": {
"type": "string",
"description": "Job Type",
"enum": [
"ACTIONSET",
"ACTION",
"CONDITION",
"CONDITION_ACTIONSET",
"CONDITION_ACTION",
"ANTIVIRUS",
"PATCH_MANAGEMENT",
"TEAMVIEWER",
"MONITOR",
"SYSTEM",
"COMMENT",
"SHADOWPROTECT",
"IMAGEMANAGER",
"HELP_REQUEST",
"SOFTWARE_PATCH_MANAGEMENT",
"SPLASHTOP",
"CLOUDBERRY",
"CLOUDBERRY_BACKUP",
"SCHEDULED_TASK",
"RDP",
"SCRIPTING",
"SECURITY",
"REMOTE_TOOLS",
"VIRTUALIZATION",
"PSA",
"MDM"
]
}
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/script/run": {
"post": {
"tags": ["Management"],
"summary": "Run script or built-in action",
"description": "Run script or built-in action on a device",
"operationId": "runScriptOnDevice",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": { "type": "string", "description": "Type", "enum": ["ACTION", "SCRIPT"] },
"id": {
"type": "integer",
"description": "Script identifier",
"format": "int32"
},
"uid": {
"type": "string",
"description": "Built-in action identifier",
"format": "uuid"
},
"parameters": { "type": "string", "description": "Action/Script parameters" },
"runAs": { "type": "string", "description": "Credential role/identifier" }
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/device/{id}/last-logged-on-user": {
"get": {
"tags": ["Devices"],
"summary": "Last logged-on user information",
"description": "Returns username that was last to login to device",
"operationId": "getDeviceLastLoggedOnUser",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userName": { "type": "string", "description": "User name" },
"logonTime": {
"type": "number",
"description": "Time of logon",
"format": "double"
}
}
}
}
}
}
},
"security": [{ "oauth2": ["monitoring"] }]
}
},
"/api/v2/device/{id}/os-patches": {
"get": {
"tags": ["Devices"],
"summary": "OS Patches",
"description": "Returns list of pending/rejected/approved OS patches for device",
"operationId": "getDevicePendingFailedRejectedOSPatches",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter",
"schema": { "type": "string" }
},
{
"name": "type",
"in": "query",
"description": "Patch Type filter",
"schema": { "type": "string" }
},
{
"name": "severity",
"in": "query",
"description": "Patch Severity filter",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"name": { "type": "string", "description": "Name" },
"severity": { "type": "string", "description": "Severity" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
},
"kbNumber": { "type": "string", "description": "KB Number" }
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/os-patch-installs": {
"get": {
"tags": ["Devices"],
"summary": "OS Patch installation report for device",
"description": "Returns patch installation history records (successful and failed) for device",
"operationId": "getDeviceInstalledOSPatches",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter (FAILED, INSTALLED)",
"schema": { "type": "string" }
},
{
"name": "installedBefore",
"in": "query",
"description": "Include patches installed before specified date",
"schema": { "type": "string" }
},
{
"name": "installedAfter",
"in": "query",
"description": "Include patches installed after specified date",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"name": { "type": "string", "description": "Name" },
"severity": { "type": "string", "description": "Severity" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
},
"kbNumber": { "type": "string", "description": "KB Number" }
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/software-patch-installs": {
"get": {
"tags": ["Devices"],
"summary": "Software Patch history for device",
"description": "Returns 3rd party software patch installation history records for device (successful and failed)",
"operationId": "getDeviceInstalledSoftwarePatches",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "type",
"in": "query",
"description": "Patch Type filter",
"schema": { "type": "string" }
},
{
"name": "impact",
"in": "query",
"description": "Patch Impact filter",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter",
"schema": { "type": "string" }
},
{
"name": "productIdentifier",
"in": "query",
"description": "Product Identifier",
"schema": { "type": "string" }
},
{
"name": "installedBefore",
"in": "query",
"description": "Include patches installed before specified date",
"schema": { "type": "string" }
},
{
"name": "installedAfter",
"in": "query",
"description": "Include patches installed after specified date",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"productIdentifier": {
"type": "string",
"description": "Software product identifier",
"format": "uuid"
},
"title": { "type": "string", "description": "Patch title" },
"impact": { "type": "string", "description": "Impact" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Patch type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
}
}
}
}
}
}
}
}
}
},
"/api/v2/device/{id}/windows-service/{serviceId}/configure": {
"post": {
"tags": ["Management"],
"summary": "Modify Windows Service configuration",
"description": "Configures Windows Service startup settings",
"operationId": "setWindowsServiceConfiguration",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "serviceId",
"in": "path",
"description": "Service identifier",
"required": true,
"schema": { "type": "string" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"startType": {
"type": "string",
"description": "Start Type",
"enum": [
"AUTO_START",
"AUTO_START_DELAYED",
"BOOT_START",
"DEMAND_START",
"DISABLED",
"SYSTEM_START"
]
},
"userName": { "type": "string", "description": "Username" }
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/device/{id}/software-patches": {
"get": {
"tags": ["Devices"],
"summary": "Pending, Failed and Rejected Software patches for device",
"description": "Returns list of 3rd party Software patches for a device (for which there were no installation attempts)",
"operationId": "getDevicePendingFailedRejectedSoftwarePatches",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Device identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter",
"schema": { "type": "string" }
},
{
"name": "productIdentifier",
"in": "query",
"description": "Product Identifier",
"schema": { "type": "string" }
},
{
"name": "type",
"in": "query",
"description": "Patch Type filter",
"schema": { "type": "string" }
},
{
"name": "impact",
"in": "query",
"description": "Patch Impact filter",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"productIdentifier": {
"type": "string",
"description": "Software product identifier",
"format": "uuid"
},
"title": { "type": "string", "description": "Patch title" },
"impact": { "type": "string", "description": "Impact" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Patch type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
}
}
}
}
}
}
}
}
}
},
"/api/v2/group/{id}/device-ids": {
"get": {
"tags": ["Groups"],
"summary": "Group members",
"description": "Returns list of device identifiers that match group criteria",
"operationId": "getGroupDeviceIds",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Group identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{ "name": "refresh", "in": "query", "schema": { "type": "string" } }
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }
}
}
}
}
}
},
"/api/v2/organization/{id}": {
"get": {
"tags": ["Organization"],
"summary": "Organization information",
"description": "Returns organization details (policy mappings, locations)",
"operationId": "getOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Organization identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": { "type": "string", "description": "Organization Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locations": {
"type": "array",
"description": "List of locations",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
}
},
"policies": {
"type": "array",
"description": "Node role policy assignments",
"items": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Policy Identifier",
"format": "int32"
}
},
"description": "Node role policy assignments"
}
},
"settings": {
"type": "object",
"properties": {
"trayicon": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"splashtop": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"teamviewer": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"backup": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"psa": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
}
},
"description": "Organization settings"
}
}
}
}
}
}
}
},
"patch": {
"tags": ["Management"],
"summary": "Update organization",
"description": "Change organization name, description and policy mappings",
"operationId": "updateOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Organization identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": { "type": "string", "description": "Organization Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
}
}
}
}
},
"responses": { "default": { "description": "default response", "content": { "*/*": {} } } }
}
},
"/api/v2/organization/{id}/locations/{locationId}": {
"patch": {
"tags": ["Management"],
"summary": "Update location",
"description": "Change location name, address, description, custom data",
"operationId": "updateLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "locationId",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
}
}
}
}
}
}
},
"/api/v2/organization/{id}/devices": {
"get": {
"tags": ["Organization"],
"summary": "Organization devices",
"description": "Returns list of devices for organization",
"operationId": "getOrganizationDevices",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Organization identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of devices to return",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "after",
"in": "query",
"description": "Last Node ID from previous page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
}
},
"description": "Device information"
}
}
}
}
}
}
}
},
"/api/v2/organization/{id}/locations": {
"get": {
"tags": ["Organization"],
"summary": "Organization locations",
"description": "Returns list of locations for organization",
"operationId": "getOrganizationLocations",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Organization identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
}
}
}
}
}
}
},
"post": {
"tags": ["Management"],
"summary": "Add new location to organization",
"description": "Creates new location for organization",
"operationId": "createLocationForOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
}
}
}
}
}
}
},
"/api/v2/organization/{id}/location/{location_id}/installer/{installer_type}": {
"get": {
"tags": ["Management"],
"summary": "Generate installer",
"description": "Generates and returns URL for installer for specified organization/location",
"operationId": "getInstallerForLocation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "location_id",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "installer_type",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": ["WINDOWS_MSI", "MAC_DMG", "MAC_PKG", "LINUX_DEB", "LINUX_RPM"]
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": { "url": { "type": "string", "description": "URL" } }
}
}
}
}
}
}
},
"/api/v2/organization/{id}/end-users": {
"get": {
"tags": ["Organization"],
"summary": "List users",
"description": "Returns list of end-users for organization",
"operationId": "getEndUsers",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"email": { "type": "string" },
"phone": { "type": "string" },
"enabled": { "type": "boolean" },
"administrator": { "type": "boolean" },
"permitAllClients": { "type": "boolean" },
"notifyAllClients": { "type": "boolean" },
"mustChangePw": { "type": "boolean" },
"mfaConfigured": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER"] },
"invitationStatus": {
"type": "string",
"enum": ["REGISTERED", "PENDING", "EXPIRED"]
},
"organizationId": {
"type": "integer",
"description": "Identifier of organization for end-users",
"format": "int32"
},
"deviceIds": {
"type": "array",
"description": "Device IDs which end-user is authorized to access",
"items": {
"type": "integer",
"description": "Device IDs which end-user is authorized to access",
"format": "int32"
}
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
}
}
}
}
}
}
}
}
},
"/api/v2/organization/{id}/documents": {
"get": {
"tags": ["Organization"],
"summary": "Organization Documents",
"description": "Returns organization documents",
"operationId": "getOrganizationDocuments",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Organization identifier",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentName": {
"type": "string",
"description": "Document Name",
"writeOnly": true
},
"fields": {
"type": "array",
"description": "Fields",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name", "writeOnly": true },
"value": { "type": "object", "description": "Value" },
"valueUpdateTime": {
"type": "number",
"description": "Value Last Updated",
"format": "double"
},
"attributeName": { "type": "string" }
}
}
},
"clientDocumentName": { "type": "string" },
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name", "writeOnly": true },
"value": { "type": "object", "description": "Value" },
"valueUpdateTime": {
"type": "number",
"description": "Value Last Updated",
"format": "double"
},
"attributeName": { "type": "string" }
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/organization/{id}/policies": {
"put": {
"tags": ["Management"],
"summary": "Change organization policy mappings",
"description": "Update policy assignment for node role(s). Returns list of affected device IDs",
"operationId": "updateNodeRolePolicyAssignmentForOrganization",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Policy Identifier",
"format": "int32"
}
},
"description": "Node role policy assignments"
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"*/*": {
"schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }
}
}
}
}
}
},
"/api/v2/queries/processors": {
"get": {
"tags": ["Queries"],
"summary": "Processor report",
"description": "Returns list of processors",
"operationId": "getProcessors",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"architecture": { "type": "string", "description": "Architecture" },
"maxClockSpeed": {
"type": "integer",
"description": "Max Clock Speed",
"format": "int64"
},
"clockSpeed": {
"type": "integer",
"description": "Current Clock Speed",
"format": "int64"
},
"name": { "type": "string", "description": "Name" },
"numCores": {
"type": "integer",
"description": "Number of Cores",
"format": "int32"
},
"numLogicalCores": {
"type": "integer",
"description": "Number of Logical Cores]",
"format": "int32"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/volumes": {
"get": {
"tags": ["Queries"],
"summary": "Disk volumes report",
"description": "Returns list of disk volumes",
"operationId": "getVolumes",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "include",
"in": "query",
"description": "Additional information to include (bl - BitLocker status)",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"driveLetter": { "type": "string", "description": "Drive Letter" },
"label": { "type": "string", "description": "Volume Label" },
"deviceType": { "type": "string", "description": "Device Type" },
"fileSystem": { "type": "string", "description": "File System Type" },
"autoMount": {
"type": "boolean",
"description": "Automatically Mounted"
},
"compressed": { "type": "boolean", "description": "Compressed" },
"capacity": {
"type": "integer",
"description": "Capacity (bytes)",
"format": "int64"
},
"freeSpace": {
"type": "integer",
"description": "Free Space (bytes)",
"format": "int64"
},
"serialNumber": { "type": "string", "description": "Serial Number" },
"bitLockerStatus": {
"type": "object",
"properties": {
"conversionStatus": {
"type": "string",
"description": "Volume encryption or decryption status.",
"enum": [
"FULLY_DECRYPTED",
"FULLY_ENCRYPTED",
"ENCRYPTION_IN_PROGRESS",
"DECRYPTION_IN_PROGRESS",
"ENCRYPTION_PAUSED",
"DECRYPTION_PAUSED",
"UNKNOWN"
]
},
"encryptionMethod": {
"type": "string",
"description": "Indicated the encryption algorithm and key size used on the volume",
"enum": [
"NONE",
"AES_128_WITH_DIFFUSER",
"AES_256_WITH_DIFFUSER",
"AES_128",
"AES_256",
"HARDWARE_ENCRYPTION",
"XTS_AES_128",
"XTS_AES_256",
"UNKNOWN"
]
},
"protectionStatus": {
"type": "string",
"description": " indicates whether the volume and its encryption key (if any) are secured.",
"enum": ["UNPROTECTED", "PROTECTED", "UNKNOWN", "PENDING"]
},
"lockStatus": {
"type": "string",
"description": "Indicates whether the contents of the volume are accessible from Windows",
"enum": ["UNKNOWN", "UNLOCKED", "LOCKED"]
},
"initializedForProtection": {
"type": "boolean",
"description": "Is initialized for protection"
}
},
"description": "BitLocker Status"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/antivirus-threats": {
"get": {
"tags": ["Queries"],
"summary": "Antivirus threats report",
"description": "Returns list of antivirus threats",
"operationId": "getAntivirusThreats",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Threat name" },
"productCode": {
"type": "string",
"description": "AntiVirus vendor product code"
},
"quarantineId": {
"type": "string",
"description": "Threat Quarantine ID"
},
"status": {
"type": "string",
"description": "Threat Status (vendor specific)"
},
"type": { "type": "string", "description": "Type of Threat" },
"threatId": {
"type": "integer",
"description": "Threat ID",
"format": "int64"
},
"category": { "type": "string", "description": "Threat Category" },
"level": { "type": "string", "description": "Threat Level" },
"detectionSource": {
"type": "string",
"description": "Detection source"
},
"traceList": {
"type": "string",
"description": "Trace list (Files, Cookies, etc. Vendor specific)"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/operating-systems": {
"get": {
"tags": ["Queries"],
"summary": "Operating systems report",
"description": "Returns operating systems' for devices",
"operationId": "getOperatingSystems",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"manufacturer": { "type": "string", "description": "Manufacturer" },
"name": { "type": "string", "description": "Name" },
"architecture": { "type": "string", "description": "Architecture" },
"lastBootTime": {
"type": "number",
"description": "Last boot time",
"format": "double"
},
"buildNumber": { "type": "string", "description": "Build number" },
"releaseId": { "type": "string", "description": "Release ID" },
"servicePackMajorVersion": {
"type": "integer",
"description": "Service Pack Major Version",
"format": "int32"
},
"servicePackMinorVersion": {
"type": "integer",
"description": "Service Pack Minor Version",
"format": "int32"
},
"locale": { "type": "string", "description": "Locale" },
"language": { "type": "string", "description": "Language" },
"needsReboot": {
"type": "boolean",
"description": "Operating system has pending reboot requests"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/computer-systems": {
"get": {
"tags": ["Queries"],
"summary": "Computer systems report",
"description": "Returns computer systems information for devices",
"operationId": "getComputerSystems",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"manufacturer": { "type": "string", "description": "Manufacturer" },
"model": { "type": "string", "description": "Model" },
"biosSerialNumber": {
"type": "string",
"description": "Bios Serial Number"
},
"serialNumber": { "type": "string", "description": "Serial Number" },
"domain": { "type": "string" },
"domainRole": { "type": "string" },
"numberOfProcessors": { "type": "integer", "format": "int32" },
"totalPhysicalMemory": { "type": "integer", "format": "int64" },
"virtualMachine": { "type": "boolean" },
"chassisType": { "type": "string" },
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/disks": {
"get": {
"tags": ["Queries"],
"summary": "Disk drives report",
"description": "Returns list of physical disks",
"operationId": "getDiskDrives",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bytesPerSector": {
"type": "integer",
"description": "Number of bytes per sector",
"format": "int32"
},
"description": { "type": "string", "description": "Description" },
"interfaceType": { "type": "string", "description": "Interface type" },
"manufacturer": { "type": "string", "description": "Manufacturer" },
"mediaType": { "type": "string", "description": "Media Type" },
"model": { "type": "string", "description": "Model" },
"name": { "type": "string", "description": "Name" },
"partitionCount": {
"type": "integer",
"description": "Number of partitions",
"format": "int32"
},
"serialNumber": { "type": "string", "description": "Serial number" },
"size": {
"type": "integer",
"description": "Size (Bytes)",
"format": "int64"
},
"smartCapable": {
"type": "boolean",
"description": "Is S.M.A.R.T. capable?"
},
"status": { "type": "string", "description": "Status" },
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/policy-overrides": {
"get": {
"tags": ["Queries"],
"summary": "Get summary of device policy overrides",
"description": "Returns list of overridden policy sections for each device",
"operationId": "getPolicyOverrides_1",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": {
"maximum": 10000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"overrides": {
"type": "array",
"description": "List of policy sections",
"items": { "type": "string", "description": "List of policy sections" }
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/device-health": {
"get": {
"tags": ["Queries"],
"summary": "Device health report",
"description": "Returns list of device health summary records",
"operationId": "getDeviceHealthReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "health",
"in": "query",
"description": "Health status filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"activeThreatsCount": {
"type": "integer",
"description": "Active AV threats count",
"format": "int32"
},
"quarantinedThreatsCount": {
"type": "integer",
"description": "Quarantined AV threats count",
"format": "int32"
},
"blockedThreatsCount": {
"type": "integer",
"description": "Blocked AV threats count",
"format": "int32"
},
"failedOSPatchesCount": {
"type": "integer",
"description": "Number of failed OS patches",
"format": "int32"
},
"pendingOSPatchesCount": {
"type": "integer",
"description": "Number of pending OS patches",
"format": "int32"
},
"alertCount": {
"type": "integer",
"description": "Alerts count",
"format": "int32"
},
"activeJobCount": {
"type": "integer",
"description": "Alerts job count",
"format": "int32"
},
"failedSoftwarePatchesCount": {
"type": "integer",
"description": "Number of failed software patches",
"format": "int32"
},
"pendingSoftwarePatchesCount": {
"type": "integer",
"description": "Number of pending software patches",
"format": "int32"
},
"pendingRebootReason": {
"type": "string",
"description": "Pending reboot reasons"
},
"avInstallStatus": {
"type": "string",
"description": "Antivirus installation status",
"enum": [
"REQUESTED",
"DOWNLOAD_STARTED",
"DOWNLOADED",
"DOWNLOAD_FAILED",
"INSTALL_STARTED",
"INSTALLED",
"INSTALL_FAILED",
"UNINSTALL_REQUESTED",
"UNINSTALL_FAILED",
"UNINSTALLED"
]
},
"productsInstallationStatuses": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "Integrated products' installation statuses",
"enum": [
"REQUESTED",
"DOWNLOAD_STARTED",
"DOWNLOADED",
"DOWNLOAD_FAILED",
"INSTALL_STARTED",
"INSTALLED",
"INSTALL_FAILED",
"UNINSTALL_REQUESTED",
"UNINSTALL_FAILED",
"UNINSTALLED"
]
},
"description": "Integrated products' installation statuses"
},
"offline": { "type": "boolean", "description": "Is device offline?" },
"parentDeviceId": {
"type": "integer",
"description": "Parent device identifier",
"format": "int32"
},
"parentOffline": {
"type": "boolean",
"description": "Is parent device offline"
},
"healthStatus": {
"type": "string",
"description": "Health status",
"enum": ["UNKNOWN", "HEALTHY", "NEEDS_ATTENTION", "UNHEALTHY"]
},
"installationIssuesCount": { "type": "integer", "format": "int32" },
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/software": {
"get": {
"tags": ["Queries"],
"summary": "Software inventory",
"description": "Returns list software installed on devices",
"operationId": "getSoftware",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "installedBefore",
"in": "query",
"description": "Include software installed before specified date",
"schema": { "type": "string" }
},
{
"name": "installedAfter",
"in": "query",
"description": "Include software installed after specified date",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"installDate": {
"type": "string",
"description": "Installation Date",
"format": "date-time"
},
"location": { "type": "string", "description": "Location" },
"name": { "type": "string", "description": "Product Name" },
"publisher": { "type": "string", "description": "Publisher" },
"size": {
"type": "integer",
"description": "Size on disk",
"format": "int64"
},
"version": { "type": "string", "description": "Version" },
"productCode": { "type": "string", "description": "Product Code" },
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/os-patch-installs": {
"get": {
"tags": ["Queries"],
"summary": "OS Patch installation report",
"description": "Returns patch installation history records (successful and failed)",
"operationId": "getInstalledOSPatches",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter (FAILED, INSTALLED)",
"schema": { "type": "string" }
},
{
"name": "installedBefore",
"in": "query",
"description": "Include patches installed before specified date",
"schema": { "type": "string" }
},
{
"name": "installedAfter",
"in": "query",
"description": "Include patches installed after specified date",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"name": { "type": "string", "description": "Name" },
"severity": { "type": "string", "description": "Severity" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
},
"kbNumber": { "type": "string", "description": "KB Number" }
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/antivirus-status": {
"get": {
"tags": ["Queries"],
"summary": "Antivirus status report",
"description": "Returns list of statues of antivirus software installed on devices",
"operationId": "getAntivirusStatusReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "productState",
"in": "query",
"description": "Product State filter",
"schema": { "type": "string" }
},
{
"name": "productName",
"in": "query",
"description": "Product Name filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productName": { "type": "string", "description": "Product name" },
"productState": { "type": "string", "description": "Product state" },
"definitionStatus": {
"type": "string",
"description": "Definition Status"
},
"version": { "type": "string", "description": "Product Version" },
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/raid-controllers": {
"get": {
"tags": ["Queries"],
"summary": "RAID controller report",
"description": "Returns list of RAID controllers",
"operationId": "getRAIDControllerReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"backupBatteryStatus": {
"type": "string",
"description": "Backup Battery Status"
},
"batteryTemperature": {
"type": "integer",
"description": "Battery Temperature",
"format": "int32"
},
"biosVersion": { "type": "string", "description": "BIOS Version" },
"cacheSize": {
"type": "integer",
"description": "Cache size (bytes)",
"format": "int64"
},
"controllerIndex": {
"type": "integer",
"description": "Controller Index",
"format": "int32"
},
"driverName": { "type": "string", "description": "Device Driver Name" },
"driverVersion": { "type": "string", "description": "Driver Version" },
"family": { "type": "string", "description": "Family" },
"firmwareVersion": {
"type": "string",
"description": "Firmware Version"
},
"hardwareRevision": {
"type": "string",
"description": "Hardware Revision"
},
"manufacturer": { "type": "string", "description": "Manufacturer" },
"manufacturingDate": {
"type": "number",
"description": "Manufacturing date",
"format": "double"
},
"model": { "type": "string", "description": "Model" },
"physicalDriveCount": {
"type": "integer",
"description": "Physical drive count",
"format": "int32"
},
"slot": { "type": "string", "description": "Slot" },
"systemHealthStatus": {
"type": "string",
"description": "System Health Status"
},
"virtualDriveCount": {
"type": "integer",
"description": "Virtual drive count",
"format": "int32"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/raid-drives": {
"get": {
"tags": ["Queries"],
"summary": "RAID drive report",
"description": "Returns list of drives connected to RAID controllers",
"operationId": "getRAIDDriveReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"controllerIndex": {
"type": "integer",
"description": "Controller index",
"format": "int32"
},
"driveGroup": { "type": "string", "description": "Drive Group" },
"driveId": { "type": "string", "description": "Drive Identifier" },
"interfaceType": { "type": "string", "description": "Interface type" },
"location": { "type": "string", "description": "Location" },
"mediaType": { "type": "string", "description": "Media type" },
"model": { "type": "string", "description": "Model" },
"protectionInfo": {
"type": "string",
"description": "Protection Information"
},
"selfEncrypted": {
"type": "boolean",
"description": "Is self encrypted?"
},
"serial": { "type": "string", "description": "Serial number" },
"size": {
"type": "integer",
"description": "Size (bytes)",
"format": "int64"
},
"spun": { "type": "boolean", "description": "Spun?" },
"status": { "type": "string", "description": "Status" },
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/windows-services": {
"get": {
"tags": ["Queries"],
"summary": "Windows services report",
"description": "Returns list of Windows Services and their statuses",
"operationId": "getWindowsServicesReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "name",
"in": "query",
"description": "Service name",
"schema": { "type": "string" }
},
{
"name": "state",
"in": "query",
"description": "Service state",
"schema": {
"type": "string",
"enum": [
"UNKNOWN",
"STOPPED",
"START_PENDING",
"RUNNING",
"STOP_PENDING",
"PAUSE_PENDING",
"PAUSED",
"CONTINUE_PENDING"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": {
"maximum": 10000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"displayName": { "type": "string", "description": "Display Name" },
"description": { "type": "string", "description": "Description" },
"startType": {
"type": "string",
"description": "Start Type",
"enum": [
"AUTO_START",
"AUTO_START_DELAYED",
"BOOT_START",
"DEMAND_START",
"DISABLED",
"SYSTEM_START"
]
},
"userName": { "type": "string", "description": "User Name" },
"state": {
"type": "string",
"description": "State",
"enum": [
"UNKNOWN",
"STOPPED",
"START_PENDING",
"RUNNING",
"STOP_PENDING",
"PAUSE_PENDING",
"PAUSED",
"CONTINUE_PENDING"
]
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/custom-fields": {
"get": {
"tags": ["Queries"],
"summary": "Custom Fields report",
"description": "Returns Custom Fields report",
"operationId": "getCustomFieldsReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": {
"maximum": 10000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "updatedAfter",
"in": "query",
"description": "Custom fields updated after specified date",
"schema": { "type": "string" }
},
{
"name": "fields",
"in": "query",
"description": "Comma-separated list of fields",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Field values"
},
"description": "Field values"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/os-patches": {
"get": {
"tags": ["Queries"],
"summary": "Pending, Failed and Rejected OS patches report",
"description": "Returns list of OS patches for which there were no installation attempts",
"operationId": "getPendingFailedRejectedOSPatches",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter",
"schema": { "type": "string" }
},
{
"name": "type",
"in": "query",
"description": "Patch Type filter",
"schema": { "type": "string" }
},
{
"name": "severity",
"in": "query",
"description": "Patch Severity filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"name": { "type": "string", "description": "Name" },
"severity": { "type": "string", "description": "Severity" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
},
"kbNumber": { "type": "string", "description": "KB Number" }
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/software-patches": {
"get": {
"tags": ["Queries"],
"summary": "Pending, Failed and Rejected Software patches report",
"description": "Returns list of 3rd party Software patches for which there were no installation attempts",
"operationId": "getPendingFailedRejectedSoftwarePatches",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "ts",
"in": "query",
"description": "Monitoring timestamp filter",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter",
"schema": { "type": "string" }
},
{
"name": "productIdentifier",
"in": "query",
"description": "Product Identifier",
"schema": { "type": "string" }
},
{
"name": "type",
"in": "query",
"description": "Patch Type filter",
"schema": { "type": "string" }
},
{
"name": "impact",
"in": "query",
"description": "Patch Impact filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"productIdentifier": {
"type": "string",
"description": "Software product identifier",
"format": "uuid"
},
"title": { "type": "string", "description": "Patch title" },
"impact": { "type": "string", "description": "Impact" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Patch type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/software-patch-installs": {
"get": {
"tags": ["Queries"],
"summary": "Software Patch history report",
"description": "Returns 3rd party software patch installation history records (successful and failed)",
"operationId": "getInstalledSoftwarePatches",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "type",
"in": "query",
"description": "Patch Type filter",
"schema": { "type": "string" }
},
{
"name": "impact",
"in": "query",
"description": "Patch Impact filter",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Patch Status filter",
"schema": { "type": "string" }
},
{
"name": "productIdentifier",
"in": "query",
"description": "Product Identifier",
"schema": { "type": "string" }
},
{
"name": "installedBefore",
"in": "query",
"description": "Include patches installed before specified date",
"schema": { "type": "string" }
},
{
"name": "installedAfter",
"in": "query",
"description": "Include patches installed after specified date",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "description": "Identifier", "format": "uuid" },
"productIdentifier": {
"type": "string",
"description": "Software product identifier",
"format": "uuid"
},
"title": { "type": "string", "description": "Patch title" },
"impact": { "type": "string", "description": "Impact" },
"status": { "type": "string", "description": "Status" },
"type": { "type": "string", "description": "Patch type" },
"installedAt": {
"type": "number",
"description": "Installation attempt timestamp",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"timestamp": {
"type": "number",
"description": "Date/Time when data was collected/updated",
"format": "double"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/logged-on-users": {
"get": {
"tags": ["Queries"],
"summary": "Last logged-on user report",
"description": "Returns usernames and logon times ",
"operationId": "getLastLoggedOnUsersReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": {
"maximum": 10000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userName": { "type": "string", "description": "User name" },
"logonTime": {
"type": "number",
"description": "Time of logon",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/queries/custom-fields-detailed": {
"get": {
"tags": ["Queries"],
"summary": "Custom Fields report",
"description": "Returns Custom Fields report with additional information about each field",
"operationId": "getCustomFieldsDetailedReport",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "cursor",
"in": "query",
"description": "Cursor name",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of records per page",
"schema": {
"maximum": 10000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "updatedAfter",
"in": "query",
"description": "Custom fields updated after specified date",
"schema": { "type": "string" }
},
{
"name": "fields",
"in": "query",
"description": "Comma-separated list of fields",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "object",
"properties": {
"name": { "type": "string" },
"offset": { "type": "integer", "format": "int32" },
"count": { "type": "integer", "format": "int32" },
"expires": { "type": "number", "format": "double" }
}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"fields": {
"type": "array",
"description": "Field values",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Field name" },
"value": { "type": "object", "description": "Field Value" },
"updated": {
"type": "number",
"description": "Last field update timestamp",
"format": "double",
"writeOnly": true
},
"updatedBy": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": ["API", "USER", "SCRIPT"]
},
"user": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" }
}
}
},
"description": "Value source (who/what updated the value)"
},
"updateTime": { "type": "number", "format": "double" }
},
"description": "Field values"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/devices/search": {
"get": {
"tags": ["System"],
"summary": "Find devices)",
"description": "Returns list of entities matching search term",
"operationId": "search",
"parameters": [
{
"name": "q",
"in": "query",
"description": "Search query (name, logged on user name, IP address, etc.)",
"schema": { "type": "string" }
},
{
"name": "limit",
"in": "query",
"description": "Limit number of devices to return",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": { "type": "string", "description": "Search query" },
"devices": {
"type": "array",
"description": "Devices matching search query",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": {
"type": "number",
"description": "Created",
"format": "double"
},
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Organization full name"
},
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"score": {
"type": "integer",
"description": "Match score",
"format": "int32"
},
"matchAttr": {
"type": "string",
"description": "Name of the attribute that matched the query"
},
"matchAttrValue": {
"type": "string",
"description": "Value of that attribute that matched"
}
},
"description": "Devices matching search query"
}
}
}
}
}
}
}
}
}
},
"/api/v2/users": {
"get": {
"tags": ["System"],
"summary": "List users",
"description": "Returns list of users",
"operationId": "getUsers",
"parameters": [
{
"name": "userType",
"in": "query",
"description": "User type filter",
"schema": { "type": "string", "enum": ["TECHNICIAN", "END_USER"] }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"email": { "type": "string" },
"phone": { "type": "string" },
"enabled": { "type": "boolean" },
"administrator": { "type": "boolean" },
"permitAllClients": { "type": "boolean" },
"notifyAllClients": { "type": "boolean" },
"mustChangePw": { "type": "boolean" },
"mfaConfigured": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER"] },
"invitationStatus": {
"type": "string",
"enum": ["REGISTERED", "PENDING", "EXPIRED"]
},
"organizationId": {
"type": "integer",
"description": "Identifier of organization for end-users",
"format": "int32"
},
"deviceIds": {
"type": "array",
"description": "Device IDs which end-user is authorized to access",
"items": {
"type": "integer",
"description": "Device IDs which end-user is authorized to access",
"format": "int32"
}
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
}
}
}
}
}
}
}
}
},
"/api/v2/policies": {
"get": {
"tags": ["System"],
"summary": "List policies",
"description": "Returns list of policies",
"operationId": "getPolicies",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
}
}
}
}
}
}
},
"post": {
"tags": ["Management"],
"summary": "Cretes new Policy",
"description": "Creates new policy using (New Root, Child, Copy)",
"operationId": "createPolicy",
"parameters": [
{
"name": "mode",
"in": "query",
"description": "Policy creation mode",
"schema": { "type": "string", "enum": ["NEW", "CHILD", "COPY"] }
},
{
"name": "templatePolicyId",
"in": "query",
"description": "Template Policy identifier",
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"enabled": {
"type": "boolean",
"description": "Policy Enabled Flag",
"default": true
}
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
}
}
}
}
}
}
},
"/api/v2/locations": {
"get": {
"tags": ["System"],
"summary": "List locations",
"description": "Returns flat list of all locations for all organizations",
"operationId": "getLocations",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "Limit number of locations to return",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "after",
"in": "query",
"description": "Last Location Identifier from previous page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
}
}
}
}
}
}
}
},
"/api/v2/devices": {
"get": {
"tags": ["System"],
"summary": "List devices",
"description": "Returns list of devices (basic node information)",
"operationId": "getDevices",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of devices to return",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "after",
"in": "query",
"description": "Last Node ID from previous page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
}
},
"description": "Device information"
}
}
}
}
}
}
}
},
"/api/v2/activities": {
"get": {
"tags": ["System"],
"summary": "List activities",
"description": "Returns activity log in reverse chronological order",
"operationId": "getActivities",
"parameters": [
{
"name": "class",
"in": "query",
"description": "Activity Class (System/Device) filter",
"schema": {
"type": "string",
"default": "ALL",
"enum": ["SYSTEM", "DEVICE", "USER", "ALL"]
}
},
{
"name": "before",
"in": "query",
"description": "Return activities recorded prior to specified date",
"schema": { "type": "string" }
},
{
"name": "after",
"in": "query",
"description": "Return activities recorded after to specified date",
"schema": { "type": "string" }
},
{
"name": "olderThan",
"in": "query",
"description": "Return activities recorded that are newer than specified activity ID",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "newerThan",
"in": "query",
"description": "Return activities recorded that are older than specified activity ID",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "type",
"in": "query",
"description": "Return activities of type",
"schema": { "type": "string" }
},
{
"name": "status",
"in": "query",
"description": "Return activities with status(es)",
"schema": { "type": "string" }
},
{
"name": "user",
"in": "query",
"description": "Return activities for user(s)",
"schema": { "type": "string" }
},
{
"name": "seriesUid",
"in": "query",
"description": "Return activities related to alert (series)",
"schema": { "type": "string" }
},
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"description": "Limit number of activities to return",
"schema": {
"maximum": 1000,
"minimum": 10,
"type": "integer",
"format": "int32",
"default": 200
}
},
{
"name": "lang",
"in": "query",
"description": "Language tag",
"schema": { "type": "string" }
},
{
"name": "tz",
"in": "query",
"description": "Time Zone",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lastActivityId": {
"type": "integer",
"description": "Last recorded activity ID for account",
"format": "int64"
},
"activities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Activity identifier",
"format": "int64"
},
"activityTime": {
"type": "number",
"description": "Activity timestamp",
"format": "double"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"severity": {
"type": "string",
"description": "Severity",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": {
"type": "string",
"description": "Priority",
"enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
},
"seriesUid": {
"type": "string",
"description": "Activity series UID (job/condition UID)",
"format": "uuid"
},
"activityType": {
"type": "string",
"description": "Activity type code",
"enum": [
"ACTIONSET",
"ACTION",
"CONDITION",
"CONDITION_ACTIONSET",
"CONDITION_ACTION",
"ANTIVIRUS",
"PATCH_MANAGEMENT",
"TEAMVIEWER",
"MONITOR",
"SYSTEM",
"COMMENT",
"SHADOWPROTECT",
"IMAGEMANAGER",
"HELP_REQUEST",
"SOFTWARE_PATCH_MANAGEMENT",
"SPLASHTOP",
"CLOUDBERRY",
"CLOUDBERRY_BACKUP",
"SCHEDULED_TASK",
"RDP",
"SCRIPTING",
"SECURITY",
"REMOTE_TOOLS",
"VIRTUALIZATION",
"PSA",
"MDM"
]
},
"statusCode": {
"type": "string",
"description": "Activity status code",
"enum": [
"START_REQUESTED",
"STARTED",
"IN_PROCESS",
"COMPLETED",
"CANCEL_REQUESTED",
"CANCELLED",
"BLOCKED",
"TRIGGERED",
"RESET",
"ACKNOWLEDGED",
"DISABLED",
"EVALUATION_FAILURE",
"CLIENT_CREATED",
"CLIENT_UPDATED",
"CLIENT_DELETED",
"CREDENTIAL_CREATED",
"CREDENTIAL_UPDATED",
"CREDENTIAL_DELETED",
"LOCATION_CREATED",
"LOCATION_UPDATED",
"LOCATION_DELETED",
"POLICY_CREATED",
"POLICY_UPDATED",
"POLICY_DELETED",
"NODE_CREATED",
"NODE_UPDATED",
"NODE_DELETED",
"NODE_ACCESS_GRANTED",
"NODE_ACCESS_DENIED",
"NODE_REGISTRATION_REJECTED",
"NODE_IDENTIFICATION_UPDATED",
"NODE_CLONING_DETECTED",
"NODE_CLONE_ADVISED_TO_REGISTER",
"NODE_MANUALLY_APPROVED",
"NODE_AUTOMATICALLY_APPROVED",
"NODE_MANUALLY_REJECTED",
"NODE_AUTOMATICALLY_REJECTED",
"REJECTED_NODE_CLEARED",
"REJECTED_NODE_DELETED",
"MOBILE_DEVICE_UNREGISTERED",
"APP_USER_CREATED",
"APP_USER_UPDATED",
"APP_USER_DELETED",
"APP_USER_LOGGED_IN",
"APP_USER_LOGGED_OUT",
"APP_USER_MFA_SETUP",
"APP_USER_MFA_DELETED",
"APP_USER_CRITICAL_ACTION",
"APP_USER_AUDIT_FAILED_LOGIN",
"END_USER_CREATED",
"END_USER_UPDATED",
"END_USER_DELETED",
"END_USER_LOGGED_IN",
"END_USER_LOGGED_OUT",
"END_USER_MFA_SETUP",
"END_USER_MFA_DELETED",
"END_USER_AUDIT_FAILED_LOGIN",
"CONTACT_CREATED",
"CONTACT_UPDATED",
"CONTACT_DELETED",
"DEVICE_GROUP_CREATED",
"DEVICE_GROUP_UPDATED",
"DEVICE_GROUP_DELETED",
"TICKET_TEMPLATE_CREATED",
"TICKET_TEMPLATE_UPDATED",
"TICKET_TEMPLATE_DELETED",
"CUSTOM_HEALTH_STATUS_CHANGED",
"CUSTOM_HEALTH_STATUS_RESET",
"PSA_TICKET_CREATION_FAILED",
"PSA_TICKET_CREATION_SUCCEEDED",
"RESET_BY_PSA_TICKET_CALLBACK",
"PSA_TICKET_CREATION_TEST",
"PSA_ENABLED",
"PSA_DISABLED",
"PSA_CREDENTIALS_FAILED",
"CONNECTWISE_AGREEMENTS_SYNC_COMPLETED",
"CONNECTWISE_AGREEMENTS_SYNC_STARTED",
"CONNECTWISE_NODE_SYNC_COMPLETED",
"CONNECTWISE_NODE_SYNC_STARTED",
"CONNECTWISE_NODE_SYNC_NODE_CREATED",
"CONNECTWISE_NODE_SYNC_NODE_UPDATED",
"CONNECTWISE_NODE_SYNC_NODE_DELETED",
"CONNECTWISE_UPDATED",
"CONNECTWISECONTROL_ATTEMPT",
"AUTOTASK_NODE_SYNC_STARTED",
"AUTOTASK_NODE_SYNC_COMPLETED",
"AUTOTASK_NODE_SYNC_NODE_CREATED",
"AUTOTASK_NODE_SYNC_NODE_UPDATED",
"AUTOTASK_NODE_SYNC_NODE_DELETED",
"AUTOTASK_UPDATED",
"REPORT_CREATED",
"REPORT_UPDATED",
"REPORT_DELETED",
"TIME_ZONE_UPDATED",
"LANGUAGE_TAG_UPDATED",
"NODE_ROLE_CREATED",
"NODE_ROLE_UPDATED",
"NODE_ROLE_DELETED",
"COMMENT",
"VIPREAV_INSTALLED",
"VIPREAV_INSTALL_FAILED",
"VIPREAV_UNINSTALLED",
"VIPREAV_UNINSTALL_FAILED",
"VIPREAV_SCAN_THREAT_QUARANTINED",
"VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED",
"VIPREAV_USERINITIATED_THREAT_QUARANTINED",
"VIPREAV_QUARANTINED_THREAT_REMOVED",
"VIPREAV_REBOOT_REQUIRED",
"VIPREAV_SCAN_STARTED",
"VIPREAV_SCAN_COMPLETED",
"VIPREAV_SCAN_ABORTED",
"VIPREAV_SCAN_FAILED",
"VIPREAV_SCAN_PAUSED",
"VIPREAV_DISABLED",
"WEBROOT_COMMAND_SUBMITTED",
"WEBROOT_THREAT_DETECTED",
"WEBROOT_INSTALL_FAILED",
"BITDEFENDER_SCAN_STARTED",
"BITDEFENDER_SCAN_COMPLETED",
"BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE",
"BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE",
"BITDEFENDER_SCAN_FAILED",
"BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED",
"BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED",
"BITDEFENDER_DOWNLOAD_STARTED",
"BITDEFENDER_DOWNLOAD_SUCCEEDED",
"BITDEFENDER_DOWNLOAD_FAILED",
"BITDEFENDER_INSTALLATION_STARTED",
"BITDEFENDER_INSTALLATION_SUCCEEDED",
"BITDEFENDER_INSTALLATION_FAILED",
"BITDEFENDER_UNINSTALLATION_STARTED",
"BITDEFENDER_UNINSTALLATION_SUCCEEDED",
"BITDEFENDER_UNINSTALLATION_FAILED",
"BITDEFENDER_UNPACKING_FAILED",
"BDAS_BITDEFENDER_THREAT_IGNORED",
"BDAS_BITDEFENDER_THREAT_PRESENT",
"BDAS_BITDEFENDER_THREAT_DELETED",
"BDAS_BITDEFENDER_THREAT_BLOCKED",
"BDAS_BITDEFENDER_THREAT_QUARANTINED",
"BDAS_BITDEFENDER_THREAT_CLEANED",
"BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED",
"BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS",
"BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED",
"BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH",
"BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED",
"BITDEFENDER_RETRY_INSTALL_COMPLETED",
"BITDEFENDER_DISABLED",
"BITDEFENDER_EXISTING_PRODUCT_UNINSTALL",
"COMPETITOR_EXISTING_PRODUCT_UNINSTALL",
"SCHEDULE_INSTALL_OPTION_CHANGED",
"SECURITY_CREDENTIAL_ACCESS_GRANTED",
"SECURITY_CREDENTIAL_ACCESS_DENIED",
"PATCH_MANAGEMENT_SCAN_STARTED",
"PATCH_MANAGEMENT_SCAN_COMPLETED",
"PATCH_MANAGEMENT_APPLY_PATCH_STARTED",
"PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED",
"PATCH_MANAGEMENT_INSTALLED",
"PATCH_MANAGEMENT_INSTALL_FAILED",
"PATCH_MANAGEMENT_MESSAGE",
"PATCH_MANAGEMENT_FAILURE",
"SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED",
"SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED",
"SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED",
"SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED",
"SOFTWARE_PATCH_MANAGEMENT_INSTALLED",
"SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED",
"SOFTWARE_PATCH_MANAGEMENT_MESSAGE",
"TEAMVIEWER_INSTALLED",
"TEAMVIEWER_INSTALL_FAILED",
"TEAMVIEWER_UNINSTALLED",
"TEAMVIEWER_UNINSTALL_FAILED",
"TEAMVIEWER_CONNECTION_ESTABLISHED",
"TEAMVIEWER_CONNECTION_TERMINATED",
"TEAMVIEWER_PERMANENT_PASSWORD_CHANGED",
"TEAMVIEWER_ACCOUNTNAME_ADDED",
"TEAMVIEWER_ACCOUNTNAME_CHANGED",
"TEAMVIEWER_ACCOUNTNAME_REMOVED",
"TEAMVIEWER_CONNECTION_CANCELLED",
"TEAMVIEWER_CONFIG_CHANGED",
"SPLASHTOP_CONNECTION_INITIATED",
"SPLASHTOP_CONNECTION_ESTABLISHED",
"SPLASHTOP_CONNECTION_TERMINATED",
"REMOTE_TOOLS_UPLOAD_FILE_INITIATED",
"REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED",
"REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED",
"REMOTE_TOOLS_RENAME_FILE_INITIATED",
"REMOTE_TOOLS_DELETE_FILE_INITIATED",
"REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS",
"REMOTE_TOOLS_MODIFY_OBJECT_FAILED",
"REMOTE_TOOLS_COPY_OBJECT_SUCCESS",
"REMOTE_TOOLS_COPY_OBJECT_FAILED",
"REMOTE_TOOLS_MOVE_OBJECT_SUCCESS",
"REMOTE_TOOLS_MOVE_OBJECT_FAILED",
"REMOTE_TOOLS_DELETE_OBJECT_SUCCESS",
"REMOTE_TOOLS_DELETE_OBJECT_FAILED",
"REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS",
"REMOTE_TOOLS_CREATE_DIRECTORY_FAILED",
"REMOTE_TOOLS_FILE_TRANSFER_SUCCESS",
"REMOTE_TOOLS_FILE_TRANSFER_FAILED",
"REMOTE_TOOLS_SERVICE_CONTROL_INITIATED",
"REMOTE_TOOLS_START_SERVICE_SUCCESS",
"REMOTE_TOOLS_START_SERVICE_FAILED",
"REMOTE_TOOLS_STOP_SERVICE_SUCCESS",
"REMOTE_TOOLS_STOP_SERVICE_FAILED",
"REMOTE_TOOLS_RESTART_SERVICE_SUCCESS",
"REMOTE_TOOLS_RESTART_SERVICE_FAILED",
"REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS",
"REMOTE_TOOLS_START_TYPE_CHANGE_FAILED",
"REMOTE_TOOLS_PROCESS_CONTROL_INITIATED",
"REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS",
"REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED",
"REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS",
"REMOTE_TOOLS_TERMINATE_PROCESS_FAILED",
"REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS",
"REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED",
"REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED",
"REMOTE_TOOLS_CREATE_KEY_SUCCESS",
"REMOTE_TOOLS_CREATE_KEY_FAILED",
"REMOTE_TOOLS_RENAME_KEY_SUCCESS",
"REMOTE_TOOLS_RENAME_KEY_FAILED",
"REMOTE_TOOLS_DELETE_KEY_SUCCESS",
"REMOTE_TOOLS_DELETE_KEY_FAILED",
"REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS",
"REMOTE_TOOLS_CREATE_PARAMETER_FAILED",
"REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS",
"REMOTE_TOOLS_RENAME_PARAMETER_FAILED",
"REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS",
"REMOTE_TOOLS_DELETE_PARAMETER_FAILED",
"REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS",
"REMOTE_TOOLS_MODIFY_PARAMETER_FAILED",
"REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED",
"ADAPTER_ADDED",
"ADAPTER_REMOVED",
"ADAPTER_CONFIG_CHANGED",
"ADAPTER_STATUS_CHANGED",
"CPU_ADDED",
"CPU_REMOVED",
"MEMORY_ADDED",
"MEMORY_REMOVED",
"DISK_DRIVE_ADDED",
"DISK_DRIVE_REMOVED",
"USER_LOGGED_IN",
"USER_LOGGED_OUT",
"PORT_OPENED",
"PORT_CLOSED",
"WINDOWS_SERVICE_STARTED",
"WINDOWS_SERVICE_STOPPED",
"MAC_DAEMON_STARTED",
"MAC_DAEMON_STOPPED",
"USER_ACCOUNT_ADDED",
"USER_ACCOUNT_REMOVED",
"PROCESS_STARTED",
"PROCESS_STOPPED",
"SYSTEM_REBOOTED",
"SOFTWARE_ADDED",
"SOFTWARE_REMOVED",
"DISK_PARTITION_ADDED",
"DISK_PARTITION_REMOVED",
"DISK_VOLUME_ADDED",
"DISK_VOLUME_REMOVED",
"CREDENTIALS_CHANGED",
"RAID_CONTROLLER_ADDED",
"RAID_CONTROLLER_REMOVED",
"RAID_PHYSICAL_DRIVE_ADDED",
"RAID_PHYSICAL_DRIVE_REMOVED",
"RAID_LOGICAL_DISK_ADDED",
"RAID_LOGICAL_DISK_REMOVED",
"BITLOCKER_ENABLED",
"BITLOCKER_DISABLED",
"FILEVAULT_ENABLED",
"FILEVAULT_DISABLED",
"TRUSTED_PLATFORM_MODULE_ENABLED",
"TRUSTED_PLATFORM_MODULE_DISABLED",
"TRUSTED_PLATFORM_MODULE_INSTALLED",
"TRUSTED_PLATFORM_MODULE_UNINSTALLED",
"SERVER_MESSAGE",
"AGENT_MESSAGE",
"WEBAPP_MESSAGE",
"DIVISION_FEATURE_ENABLED",
"DIVISION_FEATURE_DISABLED",
"NODE_JOBS_CANCELLED",
"DIVISION_STATUS_CHANGED",
"SHADOWPROTECT_INSTALLED",
"SHADOWPROTECT_INSTALL_FAILED",
"SHADOWPROTECT_UNINSTALLED",
"SHADOWPROTECT_UNINSTALL_FAILED",
"SHADOWPROTECT_BACKUPJOB_FAILED",
"SHADOWPROTECT_BACKUPJOB_ABORTED",
"SHADOWPROTECT_LICENSE_PROVISIONED",
"SHADOWPROTECT_LICENSE_PROVISION_FAILED",
"SHADOWPROTECT_LICENSE_ACTIVATED",
"SHADOWPROTECT_LICENSE_ACTIVATION_FAILED",
"SHADOWPROTECT_LICENSE_DEACTIVATED",
"SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED",
"IMAGEMANAGER_INSTALLED",
"IMAGEMANAGER_INSTALL_FAILED",
"IMAGEMANAGER_UNINSTALLED",
"IMAGEMANAGER_UNINSTALL_FAILED",
"IMAGEMANAGER_LICENSE_PROVISIONED",
"IMAGEMANAGER_LICENSE_PROVISION_FAILED",
"IMAGEMANAGER_LICENSE_ACTIVATED",
"IMAGEMANAGER_LICENSE_ACTIVATION_FAILED",
"IMAGEMANAGER_LICENSE_DEACTIVATED",
"IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED",
"IMAGEMANAGER_CONSOLIDATION_FAILED",
"IMAGEMANAGER_VERIFICATION_FAILED",
"HELP_REQUEST_SUBMITTED",
"CLOUDBERRY_INSTALLED",
"CLOUDBERRY_INSTALL_FAILED",
"CLOUDBERRY_UNINSTALLED",
"CLOUDBERRY_UNINSTALL_FAILED",
"CLOUDBERRY_BACKUPPLAN_CREATED",
"CLOUDBERRY_BACKUPPLAN_EDITED",
"CLOUDBERRY_BACKUPPLAN_DELETED",
"CLOUDBERRY_BACKUPPLAN_CREATION_FAILED",
"CLOUDBERRY_BACKUPJOB_STARTED",
"CLOUDBERRY_BACKUPJOB_SUCCEEDED",
"CLOUDBERRY_BACKUPJOB_FAILED",
"CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING",
"CLOUDBERRY_USER_CREATED",
"CLOUDBERRY_NETWORK_CREDENTIAL_CREATED",
"CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED",
"RDP_CONNECTION_INITIATED",
"RDP_CONNECTION_ESTABLISHED",
"RDP_CONNECTION_TERMINATED",
"RDP_AUTO_PROVISION",
"NC_SESSION_REQUESTED",
"NC_SESSION_STARTED",
"NC_SESSION_TERMINATED",
"NC_SESSION_SESSION_TERMINATION_REQUESTED",
"NC_SESSION_FAILED_TO_START",
"SCHEDULED_TASK_CREATED",
"SCHEDULED_TASK_UPDATED",
"SCHEDULED_TASK_DELETED",
"SCRIPT_CREATED",
"SCRIPT_UPDATED",
"SCRIPT_DELETED",
"LOCKHART_BACKUPJOB_START_REQUESTED",
"LOCKHART_BACKUPJOB_STARTED",
"LOCKHART_BACKUPJOB_IN_PROCESS",
"LOCKHART_BACKUPJOB_COMPLETED",
"LOCKHART_BACKUPJOB_FAILED",
"LOCKHART_RESTOREJOB_START_REQUESTED",
"LOCKHART_RESTOREJOB_STARTED",
"LOCKHART_RESTOREJOB_IN_PROCESS",
"LOCKHART_RESTOREJOB_COMPLETED",
"LOCKHART_RESTOREJOB_FAILED",
"LOCKHART_BACKUPJOB_COMPLETED_WITH_WARNING",
"LOCKHART_BACKUP_DOWNLOADED",
"LOCKHART_BACKUPPLAN_ADDED",
"LOCKHART_BACKUPPLAN_EDITED",
"LOCKHART_BACKUPPLAN_DELETED",
"LOCKHART_BACKUPJOB_CANCELLED",
"LOCKHART_BACKUPJOB_PROCESSING",
"LOCKHART_INSTALL_FAILED",
"LOCKHART_UNINSTALL_FAILED",
"LOCKHART_INSTALLED",
"LOCKHART_UNINSTALLED",
"LOCKHART_RESTOREJOB_CANCELLED",
"LOCKHART_BACKUPPLAN_CREATION_FAILED",
"LOCKHART_BACKUP_CONFIGURE_FAILED",
"LOCKHART_FILE_DOWNLOAD",
"LOCKHART_FOLDER_DOWNLOAD",
"LOCKHART_UPSYNCJOB_PROCESSING",
"LOCKHART_UPSYNCJOB_IN_PROCESS",
"LOCKHART_UPSYNCJOB_STARTED",
"LOCKHART_UPSYNCJOB_COMPLETED",
"LOCKHART_UPSYNCJOB_CANCELLED",
"LOCKHART_UPSYNCJOB_FAILED",
"LOCKHART_BACKUP_NAS_ACCESS_FAILED",
"LOCKHART_IMAGE_RESTORE_STARTED",
"LOCKHART_IMAGE_RESTORE_COMPLETED",
"LOCKHART_IMAGE_RESTORE_FAILED",
"LOCKHART_IMAGE_DOWNLOAD_STARTED",
"LOCKHART_IMAGE_DOWNLOAD_COMPLETED",
"LOCKHART_IMAGE_DOWNLOAD_FAILED",
"LOCKHART_IMAGE_DOWNLOAD_FILE_STARTED",
"LOCKHART_IMAGE_DOWNLOAD_FILE_COMPLETED",
"LOCKHART_IMAGE_DOWNLOAD_FILE_FAILED",
"LOCKHART_IMAGE_MOUNT_COMPLETED",
"LOCKHART_IMAGE_MOUNT_FAILED",
"LOCKHART_IMAGE_DOWNLOAD_FOLDER_STARTED",
"LOCKHART_IMAGE_DOWNLOAD_FOLDER_COMPLETED",
"LOCKHART_IMAGE_DOWNLOAD_FOLDER_FAILED",
"LOCKHART_REVISIONS_DELETE_STARTED",
"LOCKHART_REVISIONS_DELETED",
"LOCKHART_REVISIONS_DELETE_FAILED",
"LOCKHART_FOLDERS_DELETED",
"LOCKHART_FILES_DELETED",
"LOCKHART_FILES_AND_FOLDERS_DELETED",
"API_ACCESS_GRANTED",
"API_ACCESS_DENIED",
"API_WEBHOOK_CONFIGURATION_UPDATED",
"API_ACCESS_REVOKED",
"MAINTENANCE_MODE_CONFIGURED",
"MAINTENANCE_MODE_DELETED",
"MAINTENANCE_MODE_MODIFIED",
"MAINTENANCE_MODE_FAILED",
"REMOTE_SUPPORT_CREATED",
"REMOTE_SUPPORT_UPDATED",
"REMOTE_SUPPORT_DELETED",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_AND_SET_PRIMARY_GROUP_FAILED",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_AND_SET_PRIMARY_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_FAILED",
"ACTIVE_DIRECTORY_ADD_USER_TO_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_ALLOW_USER_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_ALLOW_USER_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_DISABLED_ACCOUNT_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_DISABLED_ACCOUNT_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_DISABLED_PASSWORD_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_DISABLED_PASSWORD_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_DISABLE_USER_FAILED",
"ACTIVE_DIRECTORY_DISABLE_USER_SUCCESS",
"ACTIVE_DIRECTORY_DISALLOW_USER_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_DISALLOW_USER_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_ENABLE_USER_FAILED",
"ACTIVE_DIRECTORY_ENABLE_USER_SUCCESS",
"ACTIVE_DIRECTORY_ENABLED_PASSWORD_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_ENABLED_PASSWORD_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_NOT_REQUIRE_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_NOT_REQUIRE_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_REMOVE_USER_FROM_GROUP_FAILED",
"ACTIVE_DIRECTORY_REMOVE_USER_FROM_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_REQUIRE_PASSWORD_CHANGE_FAILED",
"ACTIVE_DIRECTORY_REQUIRE_PASSWORD_CHANGE_SUCCESS",
"ACTIVE_DIRECTORY_RESET_PASSWORD_FAILED",
"ACTIVE_DIRECTORY_RESET_PASSWORD_SUCCESS",
"ACTIVE_DIRECTORY_SET_ACCOUNT_EXPIRATION_FAILED",
"ACTIVE_DIRECTORY_SET_ACCOUNT_EXPIRATION_SUCCESS",
"ACTIVE_DIRECTORY_SET_PRIMARY_GROUP_FAILED",
"ACTIVE_DIRECTORY_SET_PRIMARY_GROUP_SUCCESS",
"ACTIVE_DIRECTORY_UNLOCK_USER_SUCCESS",
"ACTIVE_DIRECTORY_UNLOCK_USER_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_JOB_RESULT_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_JOB_RESULT_SUCCESS",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DEPLOYMENT_RESULT",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CHANGE_CANDIDATE_NODE_STATUS_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CHANGE_CANDIDATE_NODE_STATUS_SUCCESS",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CLEAR_CANDIDATE_NODES_FAILED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_CLEAR_CANDIDATE_NODES_SUCCESS",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DISCOVERY_JOB_CREATED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DISCOVERY_JOB_UPDATED",
"ACTIVE_DIRECTORY_AUTO_DISCOVERY_DISCOVERY_JOB_DELETED",
"UNKNOWN",
"NINJA_TICKETING_CREATION_FAILED",
"NINJA_TICKETING_FORM_CREATED",
"NINJA_TICKETING_FORM_UPDATED",
"NINJA_TICKETING_FORM_ACTIVED",
"NINJA_TICKETING_FORM_DEACTIVED",
"NINJA_TICKETING_ATTRIBUTE_CREATED",
"NINJA_TICKETING_ATTRIBUTE_UPDATED",
"NINJA_TICKETING_ATTRIBUTE_ACTIVED",
"NINJA_TICKETING_ATTRIBUTE_DEACTIVATED",
"NINJA_TICKETING_RULESET_CREATED",
"NINJA_TICKETING_RULESET_UPDATED",
"NINJA_TICKETING_RULESET_DELETED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED",
"NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT",
"NINJA_TICKETING_TRIGGER_CREATED",
"NINJA_TICKETING_TRIGGER_UPDATED",
"NINJA_TICKETING_TRIGGER_DELETED",
"NINJA_TICKETING_TICKET_CREATED",
"NINJA_TICKETING_TICKET_DELETED",
"NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED",
"NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED",
"NINJA_TICKETING_PENDING_EMAIL_REJECTED",
"NINJA_TICKETING_ENABLED",
"NINJA_TICKETING_DISABLED",
"NINJA_TICKETING_UPDATED",
"NINJA_TICKETING_FORM_MAKE_DEFAULT",
"NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT",
"NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT",
"NINJA_TICKETING_PENDING_EMAIL_RECEIVED",
"NODE_ATTRIBUTE_CREATED",
"NODE_ATTRIBUTE_UPDATED",
"NODE_ATTRIBUTE_DELETED",
"NODE_ATTRIBUTE_VALUE_UPDATED",
"NODE_ATTRIBUTE_VALUE_DECRYPTED",
"DOCUMENT_TEMPLATE_CREATED",
"DOCUMENT_TEMPLATE_UPDATED",
"DOCUMENT_TEMPLATE_DELETED",
"CLIENT_DOCUMENT_CREATED",
"CLIENT_DOCUMENT_UPDATED",
"CLIENT_DOCUMENT_DELETED",
"CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED",
"MDM_LOCK_DEVICE_STATUS_CREATED",
"MDM_REBOOT_DEVICE_STATUS_CREATED",
"MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED",
"MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED",
"MDM_LOCK_DEVICE_STATUS_UPDATED",
"MDM_REBOOT_DEVICE_STATUS_UPDATED",
"MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED",
"MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED",
"MDM_CLEAR_PASSCODE_STATUS_CREATED",
"MDM_CLEAR_PASSCODE_STATUS_UPDATED",
"MDM_ERASE_STATUS_CREATED",
"MDM_ERASE_STATUS_UPDATED"
]
},
"status": { "type": "string", "description": "Status description" },
"activityResult": {
"type": "string",
"description": "Activity result",
"enum": ["SUCCESS", "FAILURE", "UNSUPPORTED", "UNCOMPLETED"]
},
"sourceConfigUid": {
"type": "string",
"description": "Source configuration/policy element reference",
"format": "uuid"
},
"sourceName": {
"type": "string",
"description": "Source configuration/policy element name"
},
"subject": { "type": "string", "description": "Activity subject" },
"userId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"message": { "type": "string", "description": "Activity message" },
"type": { "type": "string", "description": "Activity type description" },
"data": {
"type": "object",
"additionalProperties": true,
"description": "Activity data"
}
}
}
}
}
}
}
}
}
}
}
},
"/api/v2/groups": {
"get": {
"tags": ["System"],
"summary": "List groups (saved searches)",
"description": "Returns list of groups",
"operationId": "getGroups",
"parameters": [{ "name": "lang", "in": "query", "schema": { "type": "string" } }],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Group identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Group Name" },
"description": { "type": "string", "description": "Group description" },
"shared": {
"type": "boolean",
"description": "Group is shared with all users?"
},
"created": {
"type": "number",
"description": "Timestamp of group creation",
"format": "double"
},
"updated": {
"type": "number",
"description": "Timestamp last update",
"format": "double"
},
"deviceCount": {
"type": "integer",
"description": "Estimated/Last known device count. Can be `null` if group membership has not been evaluated recently",
"format": "int32"
},
"lastEvaluated": {
"type": "number",
"description": "Last evaluation time of group membership for nodes (search)",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
}
}
}
}
}
}
}
}
},
"/api/v2/organizations-detailed": {
"get": {
"tags": ["System"],
"summary": "List organizations (Detailed)",
"description": "Returns list of organizations with locations and policy mappings",
"operationId": "getOrganizationsDetailed",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "Limit number of organizations to return",
"schema": { "type": "integer", "format": "int32" }
},
{
"name": "after",
"in": "query",
"description": "Last Organization Identifier from previous page",
"schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locations": {
"type": "array",
"description": "List of locations",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
}
},
"policies": {
"type": "array",
"description": "Node role policy assignments",
"items": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Policy Identifier",
"format": "int32"
}
},
"description": "Node role policy assignments"
}
},
"settings": {
"type": "object",
"properties": {
"trayicon": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"splashtop": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"teamviewer": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"backup": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"psa": {
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Configured product code"
},
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": {
"type": "string",
"description": "Feature deployment targets"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Feature options"
},
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
}
},
"description": "Organization settings"
}
}
}
}
}
}
}
}
}
},
"/api/v2/roles": {
"get": {
"tags": ["System"],
"summary": "List device roles",
"description": "Returns list of device roles",
"operationId": "getNodeRoles",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
}
}
}
}
}
}
},
"/api/v2/software-products": {
"get": {
"tags": ["System"],
"summary": "List supported 3rd party software",
"description": "Returns available software products (3rd party patching)",
"operationId": "getSoftwareProducts",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Product identifier",
"format": "uuid"
},
"vendorName": { "type": "string", "description": "Vendor Name" },
"productName": { "type": "string", "description": "Product Name" },
"installable": { "type": "boolean", "description": "Installable" },
"active": { "type": "boolean", "description": "Active" }
}
}
}
}
}
}
}
}
},
"/api/v2/devices-detailed": {
"get": {
"tags": ["System"],
"summary": "List devices (detailed)",
"description": "Returns list of devices with additional information",
"operationId": "getDevicesDetailed",
"parameters": [
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"description": "Limit number of devices to return",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"description": "Last Node ID from previous page",
"format": "int32"
}
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": {
"text": { "type": "string", "description": "Note text" }
},
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
}
}
}
}
}
}
}
},
"/api/v2/alerts": {
"get": {
"tags": ["System"],
"summary": "List active alerts (triggered conditions)",
"description": "Returns list of active alerts/triggered conditions",
"operationId": "getAlerts",
"parameters": [
{
"name": "sourceType",
"in": "query",
"schema": { "type": "string", "description": "Alert Source filter" }
},
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "lang",
"in": "query",
"description": "Language tag",
"schema": { "type": "string" }
},
{
"name": "tz",
"in": "query",
"description": "Time Zone",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "Alert UID (activity series UID)",
"format": "uuid"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"message": { "type": "string", "description": "Alert message" },
"createTime": {
"type": "number",
"description": "Alert creation timestamp",
"format": "double"
},
"updateTime": {
"type": "number",
"description": "Alert last updated",
"format": "double"
},
"sourceType": {
"type": "string",
"description": "Alert origin",
"enum": [
"AGENT_OFFLINE",
"CONDITION_AGENT_CPU",
"CONDITION_AGENT_MEMORY",
"CONDITION_AGENT_NETWORK",
"CONDITION_AGENT_DISK_IO",
"CONDITION_AGENT_DISK_FREE_SPACE",
"CONDITION_AGENT_DISK_USAGE",
"CONDITION_NMS_CPU",
"CONDITION_NMS_MEMORY",
"CONDITION_NMS_NETWORK_TRAFFIC_BITS",
"CONDITION_NMS_NETWORK_TRAFFIC_PERCENT",
"CONDITION_NMS_NETWORK_STATUS",
"CONDITION_NMS_NETWORK_STATUS_CHANGE",
"CONDITION_PING",
"CONDITION_PING_LATENCY",
"CONDITION_PING_PACKET_LOSS",
"CONDITION_PING_RESPONSE",
"CONDITION_SYSTEM_UPTIME",
"CONDITION_SMART_STATUS_DEGRATED",
"CONDITION_RAID_HEALTH_STATUS",
"CONDITION_SCRIPT_RESULT",
"CONDITION_HTTP",
"CONDITION_HTTP_RESPONSE",
"CONDITION_PORT",
"CONDITION_PORT_SCAN",
"CONDITION_SYSLOG",
"CONDITION_CONFIGURATION_FILE",
"CONDITION_SNMPTRAP",
"CONDITION_CRITICAL_EVENT",
"CONDITION_DNS",
"CONDITION_EMAIL",
"SHADOWPROTECT_BACKUPJOB_CREATE",
"SHADOWPROTECT_BACKUPJOB_UPDATE",
"SHADOWPROTECT_BACKUPJOB_DELETE",
"SHADOWPROTECT_BACKUPJOB_EXECUTE",
"IMAGEMANAGER_MANAGEDFOLDER_CREATE",
"IMAGEMANAGER_MANAGEDFOLDER_UPDATE",
"IMAGEMANAGER_MANAGEDFOLDER_DELETE",
"IMAGEMANAGER_MANAGEDFOLDER_EXECUTE",
"TEAMVIEWER_CONNECTION",
"RETRIEVE_AGENT_LOGS",
"SCHEDULED_TASK",
"CONDITION_WINDOWS_EVENT_LOG_TRIGGERED",
"CONDITION_WINDOWS_SERVICE_STATE_CHANGED",
"UI_MESSAGE_ACTION_REBOOT",
"UI_MESSAGE_BD_INSTALLATION_ISSUES",
"AV_QUARANTINE_THREAT",
"AV_RESTORE_THREAT",
"AV_DELETE_THREAT",
"AV_REMOVE_THREAT",
"BITDEFENDER_RESTORE_THREAT",
"BITDEFENDER_DELETE_THREAT",
"CONDITION_BITLOCKER_STATUS",
"CONDITION_FILEVAULT_STATUS",
"CONDITION_LINUX_PROCESS",
"CONDITION_LINUX_Daemon",
"CONDITION_LINUX_PROCESS_RESOURCE",
"CONDITION_LINUX_PROCESS_RESOURCE_CPU",
"CONDITION_LINUX_PROCESS_RESOURCE_MEMORY",
"CONDITION_LINUX_DISK_FREE_SPACE",
"CONDITION_LINUX_DISK_USAGE",
"CONDITION_VM_AGGREGATE_CPU_USAGE",
"CONDITION_VM_DISK_USAGE",
"CONDITION_VM_HOST_DATASTORE",
"CONDITION_VM_HOST_UPTIME",
"CONDITION_VM_HOST_DEVICE_DOWN",
"CONDITION_VM_HOST_BAD_SENSORS",
"CONDITION_VM_HOST_SENSOR_HEALTH",
"CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE",
"CONDITION_VM_GUEST_SNAPSHOT_SIZE",
"CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN",
"CONDITION_VM_GUEST_TOOLS_NOT_RUNNING",
"CONDITION_HV_GUEST_CHECKPOINT_SIZE",
"CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN",
"CONDITION_SOFTWARE",
"CONDITION_WINDOWS_PROCESS_STATE",
"CONDITION_WINDOWS_PROCESS_RESOURCE_CPU",
"CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_PROCESS_STATE",
"CONDITION_MAC_PROCESS_RESOURCE_CPU",
"CONDITION_MAC_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_DEAMON"
]
},
"sourceConfigUid": {
"type": "string",
"description": "Source configuration/policy element reference",
"format": "uuid"
},
"sourceName": {
"type": "string",
"description": "Source configuration/policy element name"
},
"subject": { "type": "string", "description": "Alert subject" },
"userId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"psaTicketId": {
"type": "integer",
"description": "Related PSA ticket ID",
"format": "int64"
},
"ticketTemplateId": {
"type": "integer",
"description": "PSA ticket template",
"format": "int32"
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Alert data"
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": {
"type": "number",
"description": "Created",
"format": "double"
},
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Organization full name"
},
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
}
},
"description": "Device information"
}
}
}
}
}
}
}
}
}
},
"/api/v2/jobs": {
"get": {
"tags": ["System"],
"summary": "List active jobs",
"description": "Returns list of running jobs",
"operationId": "getActiveJobs",
"parameters": [
{
"name": "jobType",
"in": "query",
"description": "Job Type filter",
"schema": { "type": "string" }
},
{
"name": "df",
"in": "query",
"description": "Device filter",
"schema": { "type": "string" }
},
{
"name": "lang",
"in": "query",
"description": "Language tag",
"schema": { "type": "string" }
},
{
"name": "tz",
"in": "query",
"description": "Time Zone",
"schema": { "type": "string" }
}
],
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "Task/Job UID (activity series UID)",
"format": "uuid"
},
"deviceId": {
"type": "integer",
"description": "Device identifier",
"format": "int32"
},
"message": { "type": "string", "description": "Job message" },
"createTime": {
"type": "number",
"description": "Job start timestamp",
"format": "double"
},
"updateTime": {
"type": "number",
"description": "Job last updated",
"format": "double"
},
"sourceType": {
"type": "string",
"description": "Job origin",
"enum": [
"AGENT_OFFLINE",
"CONDITION_AGENT_CPU",
"CONDITION_AGENT_MEMORY",
"CONDITION_AGENT_NETWORK",
"CONDITION_AGENT_DISK_IO",
"CONDITION_AGENT_DISK_FREE_SPACE",
"CONDITION_AGENT_DISK_USAGE",
"CONDITION_NMS_CPU",
"CONDITION_NMS_MEMORY",
"CONDITION_NMS_NETWORK_TRAFFIC_BITS",
"CONDITION_NMS_NETWORK_TRAFFIC_PERCENT",
"CONDITION_NMS_NETWORK_STATUS",
"CONDITION_NMS_NETWORK_STATUS_CHANGE",
"CONDITION_PING",
"CONDITION_PING_LATENCY",
"CONDITION_PING_PACKET_LOSS",
"CONDITION_PING_RESPONSE",
"CONDITION_SYSTEM_UPTIME",
"CONDITION_SMART_STATUS_DEGRATED",
"CONDITION_RAID_HEALTH_STATUS",
"CONDITION_SCRIPT_RESULT",
"CONDITION_HTTP",
"CONDITION_HTTP_RESPONSE",
"CONDITION_PORT",
"CONDITION_PORT_SCAN",
"CONDITION_SYSLOG",
"CONDITION_CONFIGURATION_FILE",
"CONDITION_SNMPTRAP",
"CONDITION_CRITICAL_EVENT",
"CONDITION_DNS",
"CONDITION_EMAIL",
"SHADOWPROTECT_BACKUPJOB_CREATE",
"SHADOWPROTECT_BACKUPJOB_UPDATE",
"SHADOWPROTECT_BACKUPJOB_DELETE",
"SHADOWPROTECT_BACKUPJOB_EXECUTE",
"IMAGEMANAGER_MANAGEDFOLDER_CREATE",
"IMAGEMANAGER_MANAGEDFOLDER_UPDATE",
"IMAGEMANAGER_MANAGEDFOLDER_DELETE",
"IMAGEMANAGER_MANAGEDFOLDER_EXECUTE",
"TEAMVIEWER_CONNECTION",
"RETRIEVE_AGENT_LOGS",
"SCHEDULED_TASK",
"CONDITION_WINDOWS_EVENT_LOG_TRIGGERED",
"CONDITION_WINDOWS_SERVICE_STATE_CHANGED",
"UI_MESSAGE_ACTION_REBOOT",
"UI_MESSAGE_BD_INSTALLATION_ISSUES",
"AV_QUARANTINE_THREAT",
"AV_RESTORE_THREAT",
"AV_DELETE_THREAT",
"AV_REMOVE_THREAT",
"BITDEFENDER_RESTORE_THREAT",
"BITDEFENDER_DELETE_THREAT",
"CONDITION_BITLOCKER_STATUS",
"CONDITION_FILEVAULT_STATUS",
"CONDITION_LINUX_PROCESS",
"CONDITION_LINUX_Daemon",
"CONDITION_LINUX_PROCESS_RESOURCE",
"CONDITION_LINUX_PROCESS_RESOURCE_CPU",
"CONDITION_LINUX_PROCESS_RESOURCE_MEMORY",
"CONDITION_LINUX_DISK_FREE_SPACE",
"CONDITION_LINUX_DISK_USAGE",
"CONDITION_VM_AGGREGATE_CPU_USAGE",
"CONDITION_VM_DISK_USAGE",
"CONDITION_VM_HOST_DATASTORE",
"CONDITION_VM_HOST_UPTIME",
"CONDITION_VM_HOST_DEVICE_DOWN",
"CONDITION_VM_HOST_BAD_SENSORS",
"CONDITION_VM_HOST_SENSOR_HEALTH",
"CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE",
"CONDITION_VM_GUEST_SNAPSHOT_SIZE",
"CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN",
"CONDITION_VM_GUEST_TOOLS_NOT_RUNNING",
"CONDITION_HV_GUEST_CHECKPOINT_SIZE",
"CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN",
"CONDITION_SOFTWARE",
"CONDITION_WINDOWS_PROCESS_STATE",
"CONDITION_WINDOWS_PROCESS_RESOURCE_CPU",
"CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_PROCESS_STATE",
"CONDITION_MAC_PROCESS_RESOURCE_CPU",
"CONDITION_MAC_PROCESS_RESOURCE_MEMORY",
"CONDITION_MAC_DEAMON"
]
},
"sourceConfigUid": {
"type": "string",
"description": "Source configuration/policy element reference",
"format": "uuid"
},
"sourceName": {
"type": "string",
"description": "Source configuration/policy element name"
},
"subject": { "type": "string", "description": "Job subject" },
"userId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"psaTicketId": {
"type": "integer",
"description": "Related PSA ticket ID",
"format": "int64"
},
"ticketTemplateId": {
"type": "integer",
"description": "PSA ticket template",
"format": "int32"
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Job data"
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": {
"type": "number",
"description": "Created",
"format": "double"
},
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Organization full name"
},
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": {
"type": "boolean",
"description": "Is custom node role?"
},
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
}
},
"description": "Device information"
},
"jobStatus": {
"type": "string",
"description": "Job Status",
"enum": [
"START_REQUESTED",
"STARTED",
"IN_PROCESS",
"COMPLETED",
"CANCEL_REQUESTED",
"CANCELLED",
"TRIGGERED",
"RESET",
"ACKNOWLEDGED",
"DISABLED"
]
},
"jobResult": {
"type": "string",
"description": "Job result",
"enum": ["SUCCESS", "FAILURE", "UNSUPPORTED", "UNCOMPLETED"]
},
"jobType": {
"type": "string",
"description": "Job Type",
"enum": [
"ACTIONSET",
"ACTION",
"CONDITION",
"CONDITION_ACTIONSET",
"CONDITION_ACTION",
"ANTIVIRUS",
"PATCH_MANAGEMENT",
"TEAMVIEWER",
"MONITOR",
"SYSTEM",
"COMMENT",
"SHADOWPROTECT",
"IMAGEMANAGER",
"HELP_REQUEST",
"SOFTWARE_PATCH_MANAGEMENT",
"SPLASHTOP",
"CLOUDBERRY",
"CLOUDBERRY_BACKUP",
"SCHEDULED_TASK",
"RDP",
"SCRIPTING",
"SECURITY",
"REMOTE_TOOLS",
"VIRTUALIZATION",
"PSA",
"MDM"
]
}
}
}
}
}
}
}
}
}
},
"/api/v2/tasks": {
"get": {
"tags": ["System"],
"summary": "List scheduled tasks",
"description": "Returns list of registered scheduled tasks",
"operationId": "getScheduledTasks",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Scheduled Task identifier" },
"id": { "type": "integer", "format": "int32" },
"description": { "type": "string", "description": "Description" },
"enabled": { "type": "boolean", "description": "Is Enabled ?" },
"created": {
"type": "number",
"description": "Timestamp of Scheduled Task creation",
"format": "double"
},
"lastRun": {
"type": "number",
"description": "Timestamp of last Scheduled Task run",
"format": "double"
},
"runCount": {
"type": "integer",
"description": "Number of times scheduled task ran",
"format": "int32"
}
}
}
}
}
}
}
}
}
},
"/api/v2/device-custom-fields": {
"get": {
"tags": ["System"],
"summary": "Device Custom Fields",
"description": "Returns list of all custom fields",
"operationId": "getDeviceGlobalCustomFields",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"description": "Entity Type",
"enum": ["USER", "NODE", "TICKET", "DOCUMENT"]
},
"scope": {
"type": "string",
"description": "Scope",
"enum": ["NODE_GLOBAL", "NODE_ROLE", "NODE_CLASS"]
},
"type": {
"type": "string",
"description": "Type",
"enum": [
"DROPDOWN",
"MULTI_SELECT",
"CHECKBOX",
"TEXT",
"TEXT_MULTILINE",
"TEXT_ENCRYPTED",
"NUMERIC",
"DECIMAL",
"DATE",
"DATE_TIME",
"TIME",
"ATTACHMENT",
"NODE_DROPDOWN",
"NODE_MULTI_SELECT",
"CLIENT_DROPDOWN",
"CLIENT_MULTI_SELECT",
"CLIENT_LOCATION_DROPDOWN",
"CLIENT_LOCATION_MULTI_SELECT",
"CLIENT_DOCUMENT_DROPDOWN",
"CLIENT_DOCUMENT_MULTI_SELECT",
"EMAIL",
"PHONE",
"IP_ADDRESS",
"WYSIWYG",
"URL"
]
},
"label": { "type": "string", "description": "Label" },
"description": { "type": "string", "description": "Description" },
"name": { "type": "string", "description": "Name" },
"defaultValue": { "type": "string", "description": "Default Value" },
"endUserPermission": {
"type": "string",
"description": "End User Permission",
"enum": ["HIDDEN", "EDITABLE_OPTIONAL", "EDITABLE_REQUIRED", "READ_ONLY"]
},
"technicianPermission": {
"type": "string",
"description": "Technician Permission",
"enum": ["NONE", "EDITABLE", "READ_ONLY"]
},
"scriptPermission": {
"type": "string",
"description": "Script Permission",
"enum": ["NONE", "READ_ONLY", "WRITE_ONLY", "READ_WRITE"]
},
"content": {
"type": "object",
"properties": {
"customizeForEndUser": { "type": "boolean" },
"endUserCustomization": {
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" },
"label": { "type": "string" }
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"name": { "type": "string" },
"active": { "type": "boolean" },
"System": { "type": "boolean" }
}
}
},
"required": { "type": "boolean" },
"footerText": { "type": "string" },
"tooltipText": { "type": "string" },
"advancedSettings": { "type": "object", "additionalProperties": true }
},
"description": "Content"
},
"System": { "type": "boolean", "description": "System" },
"active": { "type": "boolean", "description": "Active" },
"createTime": {
"type": "number",
"description": "Create Time",
"format": "double"
},
"updateTime": {
"type": "number",
"description": "Update Time",
"format": "double"
}
}
}
}
}
}
}
}
}
},
"/api/v2/ticketing/ticket-form": {
"get": {
"tags": ["Ticketing"],
"summary": "Get list of ticket forms",
"description": "Get list of ticket forms ",
"operationId": "getTicketForms",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"description": { "type": "string" },
"endUserTitle": { "type": "string" },
"content": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"timerSettings": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"mode": { "type": "string", "enum": ["MANUAL", "AUTO_START"] }
}
}
}
},
"active": { "type": "boolean" },
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"default": { "type": "boolean" }
}
}
}
}
}
}
}
}
},
"/api/v2/ticketing/trigger/board/{boardId}/run": {
"post": {
"tags": ["Ticketing"],
"summary": "Get list of tickets for board",
"description": "Get list of tickets by board identifier for PublicAPI",
"operationId": "getTickets",
"parameters": [
{
"name": "boardId",
"in": "path",
"required": true,
"schema": { "type": "integer", "format": "int32" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sortBy": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": { "type": "string" },
"direction": { "type": "string", "enum": ["ASC", "DESC"] }
}
}
},
"filters": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": { "type": "string" },
"operator": { "type": "string" },
"value": { "type": "string" }
}
}
},
"lastCursorId": { "type": "integer", "format": "int32" },
"pageSize": { "type": "integer", "format": "int32" },
"searchCriteria": { "type": "string" }
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": { "type": "object", "additionalProperties": { "type": "object" } }
},
"metadata": {
"type": "object",
"properties": {
"columns": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"sortBy": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": { "type": "string" },
"direction": { "type": "string", "enum": ["ASC", "DESC"] }
}
}
},
"filters": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": { "type": "string" },
"operator": { "type": "string" },
"value": { "type": "string" }
}
}
},
"lastCursorId": { "type": "integer", "format": "int32" }
}
}
}
}
}
}
}
}
}
},
"/api/v2/ticketing/trigger/boards": {
"get": {
"tags": ["Ticketing"],
"summary": "Get list of boards",
"description": "Get list of boards from PublicAPI ",
"operationId": "getBoards",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"name": { "type": "string" },
"description": { "type": "string" },
"conditions": {
"type": "object",
"properties": {
"any": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": { "type": "string" },
"operator": { "type": "string" },
"value": { "type": "string" }
}
}
},
"all": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": { "type": "string" },
"operator": { "type": "string" },
"value": { "type": "string" }
}
}
}
}
},
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"System": { "type": "boolean" },
"columns": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"sortBy": {
"uniqueItems": true,
"type": "array",
"items": { "type": "object", "additionalProperties": { "type": "object" } }
},
"ticketCount": { "type": "integer", "format": "int32" }
}
}
}
}
}
}
}
}
},
"/api/v2/ticketing/contact/contacts": {
"get": {
"tags": ["Ticketing"],
"summary": "Get list of contacts",
"description": "Get list of contacts from PublicAPI ",
"operationId": "getContacts",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"clientId": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"email": { "type": "string" },
"phone": { "type": "string" },
"jobTitle": { "type": "string" },
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" }
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"FeatureSettings": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"Location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": { "type": "integer", "description": "Location identifier", "format": "int32" }
},
"description": "Location"
},
"NodeRolePolicyAssignment": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": { "type": "integer", "description": "Policy Identifier", "format": "int32" }
},
"description": "Node role policy assignments"
},
"OrganizationDetailed": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": { "type": "string", "description": "Organization Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": { "type": "integer", "description": "Organization identifier", "format": "int32" },
"locations": {
"type": "array",
"description": "List of locations",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"id": { "type": "integer", "description": "Location identifier", "format": "int32" }
},
"description": "Location"
}
},
"policies": {
"type": "array",
"description": "Node role policy assignments",
"items": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Policy Identifier",
"format": "int32"
}
},
"description": "Node role policy assignments"
}
},
"settings": {
"type": "object",
"properties": {
"trayicon": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"splashtop": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"teamviewer": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"backup": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"psa": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
}
},
"description": "Organization settings"
}
}
},
"OrganizationSettings": {
"type": "object",
"properties": {
"trayicon": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"splashtop": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"teamviewer": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"backup": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
},
"psa": {
"type": "object",
"properties": {
"product": { "type": "string", "description": "Configured product code" },
"enabled": { "type": "boolean", "description": "Is enabled" },
"targets": {
"type": "array",
"description": "Feature deployment targets",
"items": { "type": "string", "description": "Feature deployment targets" }
},
"options": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Feature options" },
"description": "Feature options"
}
},
"description": "Feature/product/integration configuration settings"
}
},
"description": "Organization settings"
},
"LocationModel": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
}
},
"OrganizationWithLocationsAndPolicyAssignmentsModel": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": { "type": "string", "description": "Organization Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"locations": {
"type": "array",
"description": "List of locations",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
}
}
},
"policies": {
"type": "array",
"description": "Node role policy assignments",
"items": {
"type": "object",
"properties": {
"nodeRoleId": {
"type": "integer",
"description": "Node Role Identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Policy Identifier",
"format": "int32"
}
},
"description": "Node role policy assignments"
}
}
}
},
"HTTPHeader": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Header name" },
"value": { "type": "string", "description": "Header value" }
},
"description": "Custom HTTP Headers (i.e. Authorization)"
},
"WebhookConfiguration": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Callback (WebHook) URL for activity notifications"
},
"activities": {
"type": "object",
"additionalProperties": {
"type": "array",
"description": "Activity filter",
"items": { "type": "string", "description": "Activity filter" }
},
"description": "Activity filter"
},
"expand": {
"type": "array",
"description": "Which references to expand in payloads",
"items": { "type": "string", "description": "Which references to expand in payloads" }
},
"headers": {
"type": "array",
"description": "Custom HTTP Headers (i.e. Authorization)",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Header name" },
"value": { "type": "string", "description": "Header value" }
},
"description": "Custom HTTP Headers (i.e. Authorization)"
}
}
}
},
"DeviceIDList": {
"type": "object",
"properties": {
"devices": { "type": "array", "items": { "type": "integer", "format": "int32" } }
}
},
"AppUser": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"email": { "type": "string" },
"phone": { "type": "string" },
"phoneVerified": { "type": "boolean", "writeOnly": true },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"password": { "type": "string" },
"mustChangePw": { "type": "boolean" },
"enabled": { "type": "boolean" },
"contentNode": { "type": "object", "additionalProperties": true },
"ninjaAdmin": { "type": "boolean" },
"sysadmin": { "type": "boolean" },
"permitAllClients": { "type": "boolean" },
"notifyAllClients": { "type": "boolean" },
"masterMspUser": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER"] },
"clientId": { "type": "integer", "format": "int32" },
"favorites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
}
},
"recents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
}
},
"authenticationType": { "type": "string", "enum": ["NATIVE", "SSO"] },
"roleIds": {
"uniqueItems": true,
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"ownerRoleId": { "type": "integer", "format": "int32" },
"appUserClientMap": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"permit": { "type": "boolean" },
"notify": { "type": "boolean" }
}
}
},
"fileFolderBackupAllowed": { "type": "boolean" },
"emailNotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
},
"u2FTokenCount": { "type": "integer", "format": "int32" },
"pwResetTime": { "type": "number", "format": "double" },
"invitationAcceptedTime": { "type": "number", "format": "double" },
"name": { "type": "string" },
"displayName": { "type": "string" },
"ticketingAdmin": { "type": "boolean" },
"phoneMasked": { "type": "string" },
"smsotpconfigured": { "type": "boolean" },
"totpconfigured": { "type": "boolean" },
"u2FConfigured": { "type": "boolean" },
"plainPassword": { "type": "string", "writeOnly": true },
"emailFormatLegacy": { "type": "boolean" },
"mfaconfigured": { "type": "boolean" },
"invitationAccepted": { "type": "boolean" },
"globalEndUser": { "type": "boolean" },
"technician": { "type": "boolean" },
"endUser": { "type": "boolean" },
"divisionContext": { "$ref": "#/components/schemas/IDivisionContext" },
"preferredMFAType": { "type": "string", "enum": ["NONE", "TOTP", "SMSOTP", "U2F_TOKEN"] },
"smsnotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
}
}
},
"AppUserAndContact": {
"type": "object",
"properties": {
"uid": { "type": "string", "format": "uuid" },
"clientId": { "type": "integer", "format": "int32" },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"email": { "type": "string" },
"deleted": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER", "CONTACT"] },
"appUser": { "type": "boolean" }
}
},
"AppUserClient": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"permit": { "type": "boolean" },
"notify": { "type": "boolean" }
}
},
"AppUserTab": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
},
"AttributeValueAttachment": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
},
"AttributeValueEntityReference": {
"type": "object",
"properties": {
"entityId": { "type": "integer", "format": "int32" },
"type": { "type": "string", "enum": ["NODE", "CLIENT", "CLIENT_LOCATION"] }
}
},
"AttributeValueEntityReferences": {
"type": "object",
"properties": {
"entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } },
"type": { "type": "string", "enum": ["NODE", "CLIENT", "CLIENT_LOCATION"] }
}
},
"AttributeValueUpdatedByInfo": {
"type": "object",
"properties": {
"source": { "type": "string", "enum": ["API", "USER", "SCRIPT"] },
"user": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" }
}
}
},
"description": "Value source (who/what updated the value)"
},
"AttributeValueWYSIWYG": {
"type": "object",
"properties": {
"text": { "type": "string" },
"html": { "type": "string" },
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
}
}
}
},
"BackupLocationConfig": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
},
"CcList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }
}
},
"CentralDivision": {
"type": "object",
"properties": {
"uid": { "type": "string", "format": "uuid" },
"localizedDateTimeFormatterLong": {
"type": "object",
"properties": {
"locale": {
"type": "object",
"properties": {
"language": { "type": "string" },
"script": { "type": "string" },
"country": { "type": "string" },
"variant": { "type": "string" },
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"iso3Language": { "type": "string" },
"iso3Country": { "type": "string" },
"displayLanguage": { "type": "string" },
"displayScript": { "type": "string" },
"displayCountry": { "type": "string" },
"displayVariant": { "type": "string" },
"displayName": { "type": "string" }
}
},
"decimalStyle": {
"type": "object",
"properties": {
"zeroDigit": { "type": "string" },
"positiveSign": { "type": "string" },
"negativeSign": { "type": "string" },
"decimalSeparator": { "type": "string" }
}
},
"resolverStyle": { "type": "string", "enum": ["STRICT", "SMART", "LENIENT"] },
"resolverFields": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"baseUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"rangeUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"dateBased": { "type": "boolean" }
}
}
},
"zone": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"properties": {
"fixedOffset": { "type": "boolean" },
"transitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"gap": { "type": "boolean" },
"overlap": { "type": "boolean" },
"dateTimeBefore": { "type": "string", "format": "date-time" },
"dateTimeAfter": { "type": "string", "format": "date-time" },
"instant": { "type": "number", "format": "double" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
}
},
"transitionRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"timeDefinition": {
"type": "string",
"enum": ["UTC", "WALL", "STANDARD"]
},
"standardOffset": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"dayOfWeek": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"dayOfMonthIndicator": { "type": "integer", "format": "int32" },
"localTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"midnightEndOfDay": { "type": "boolean" }
}
}
}
}
},
"id": { "type": "string" }
}
},
"chronology": {
"type": "object",
"properties": { "calendarType": { "type": "string" }, "id": { "type": "string" } }
}
}
},
"localizedDateTimeFormatterShort": {
"type": "object",
"properties": {
"locale": {
"type": "object",
"properties": {
"language": { "type": "string" },
"script": { "type": "string" },
"country": { "type": "string" },
"variant": { "type": "string" },
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"iso3Language": { "type": "string" },
"iso3Country": { "type": "string" },
"displayLanguage": { "type": "string" },
"displayScript": { "type": "string" },
"displayCountry": { "type": "string" },
"displayVariant": { "type": "string" },
"displayName": { "type": "string" }
}
},
"decimalStyle": {
"type": "object",
"properties": {
"zeroDigit": { "type": "string" },
"positiveSign": { "type": "string" },
"negativeSign": { "type": "string" },
"decimalSeparator": { "type": "string" }
}
},
"resolverStyle": { "type": "string", "enum": ["STRICT", "SMART", "LENIENT"] },
"resolverFields": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"baseUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"rangeUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"dateBased": { "type": "boolean" }
}
}
},
"zone": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"properties": {
"fixedOffset": { "type": "boolean" },
"transitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"gap": { "type": "boolean" },
"overlap": { "type": "boolean" },
"dateTimeBefore": { "type": "string", "format": "date-time" },
"dateTimeAfter": { "type": "string", "format": "date-time" },
"instant": { "type": "number", "format": "double" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
}
},
"transitionRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"timeDefinition": {
"type": "string",
"enum": ["UTC", "WALL", "STANDARD"]
},
"standardOffset": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"dayOfWeek": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"dayOfMonthIndicator": { "type": "integer", "format": "int32" },
"localTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"midnightEndOfDay": { "type": "boolean" }
}
}
}
}
},
"id": { "type": "string" }
}
},
"chronology": {
"type": "object",
"properties": { "calendarType": { "type": "string" }, "id": { "type": "string" } }
}
}
},
"timeZoneId": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"properties": {
"fixedOffset": { "type": "boolean" },
"transitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"gap": { "type": "boolean" },
"overlap": { "type": "boolean" },
"dateTimeBefore": { "type": "string", "format": "date-time" },
"dateTimeAfter": { "type": "string", "format": "date-time" },
"instant": { "type": "number", "format": "double" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
}
},
"transitionRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"timeDefinition": { "type": "string", "enum": ["UTC", "WALL", "STANDARD"] },
"standardOffset": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"dayOfWeek": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"dayOfMonthIndicator": { "type": "integer", "format": "int32" },
"localTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"midnightEndOfDay": { "type": "boolean" }
}
}
}
}
},
"id": { "type": "string" }
}
},
"timeZone": {
"type": "object",
"properties": {
"dstsavings": { "type": "integer", "format": "int32" },
"rawOffset": { "type": "integer", "format": "int32" },
"id": { "type": "string" },
"displayName": { "type": "string" }
}
},
"calendar": { "type": "string", "format": "date-time" },
"locale": {
"type": "object",
"properties": {
"language": { "type": "string" },
"script": { "type": "string" },
"country": { "type": "string" },
"variant": { "type": "string" },
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"iso3Language": { "type": "string" },
"iso3Country": { "type": "string" },
"displayLanguage": { "type": "string" },
"displayScript": { "type": "string" },
"displayCountry": { "type": "string" },
"displayVariant": { "type": "string" },
"displayName": { "type": "string" }
}
},
"brandingEnabled": { "type": "boolean" },
"email": { "type": "string" },
"companyName": { "type": "string" },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"phone": { "type": "string" },
"created": { "type": "number", "format": "double" },
"dbName": { "type": "string" },
"trialLicense": { "type": "boolean" },
"licenseExpiration": { "type": "number", "format": "double" },
"engaged": { "type": "number", "format": "double" },
"reportingKey": { "type": "string", "format": "uuid" },
"timeZoneIdString": { "type": "string" },
"languageTag": { "type": "string" },
"contentNode": { "type": "object", "additionalProperties": true },
"locallyEngaged": { "type": "number", "format": "double" },
"brandingNode": { "type": "object", "additionalProperties": true },
"hostname": { "type": "string" },
"state": {
"type": "string",
"enum": [
"UNKNOWN",
"ACTIVE",
"SUSPENDED",
"ARCHIVED",
"ACCESS_RESTRICTED",
"MAINTENANCE",
"MIGRATING",
"MOVED"
]
},
"zone": { "type": "string" },
"dbHost": { "type": "string" },
"dataKey": { "type": "string" },
"securityNode": { "type": "object", "additionalProperties": true },
"region": { "type": "string" },
"ticketingEmailDomain": {
"type": "object",
"properties": {
"domain": { "type": "string" },
"fromEmailDomain": { "type": "string" },
"useFromEmailDomain": { "type": "boolean" }
}
},
"parentDivisionUid": { "type": "string", "format": "uuid" },
"enabledFeatures": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"rdp",
"cbS3Stats",
"vmware",
"cloudberry",
"Ticketing",
"ninja_control",
"remotesupport",
"macff",
"desktopcompanion",
"override_remote_client_ip",
"documentation",
"hyperv",
"ad_management",
"ninja_psa",
"ad_discovery",
"user_permission",
"notification_channels",
"mdm",
"custom_snmp",
"ticketing_mobile",
"cloud_image_mounting",
"legacy_backup_products",
"template_library",
"device_dashboard_show_task_membership",
"skip_mfa"
]
}
},
"companyDisplayName": { "type": "string" },
"additionalHostnames": { "type": "array", "items": { "type": "string" } },
"ninjaId": { "type": "string" },
"salesforceId": { "type": "string" },
"ipsubnetWhitelist": { "type": "array", "items": { "type": "object" } },
"expired": { "type": "boolean" },
"new": { "type": "boolean" }
}
},
"Client": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"name": { "type": "string" },
"description": { "type": "string" },
"psaId": { "type": "integer", "format": "int64" },
"psaName": { "type": "string" },
"folderUid": { "type": "string", "format": "uuid" },
"inHouse": { "type": "boolean" },
"contentNode": { "type": "object", "additionalProperties": true },
"defaultLocationId": { "type": "integer", "format": "int32" },
"userData": { "type": "object", "additionalProperties": true },
"remoteSupportFolder": { "type": "boolean" },
"clientPolicyList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"policyId": { "type": "integer", "format": "int32" }
}
}
},
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"credentialsMap": {
"type": "object",
"additionalProperties": { "type": "integer", "format": "int32" }
},
"approvalMode": { "type": "string", "enum": ["AUTOMATIC", "MANUAL", "REJECT"] },
"valid": { "type": "boolean" },
"content": { "type": "string" },
"connectWiseNode": { "type": "object", "additionalProperties": true },
"psaIdAsInt": { "type": "integer", "format": "int32" },
"productCode": {
"type": "string",
"enum": [
"SHADOWPROTECT",
"IMAGEMANAGER",
"VIPRE",
"SPLASHTOP",
"CLOUDBERRY",
"WEBROOT",
"BITDEFENDER",
"LOCKHART",
"CONNECTWISE"
]
},
"validForPsaTicketCreate": { "type": "boolean" }
}
},
"ClientLocation": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"address": { "type": "string" },
"description": { "type": "string" },
"userData": { "type": "object", "additionalProperties": true },
"psaLocationId": { "type": "integer", "format": "int32" },
"psaLocationName": { "type": "string" },
"clientId": { "type": "integer", "format": "int32" },
"default": { "type": "boolean" },
"locationContent": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
},
"networkLocationEnabled": { "type": "boolean" },
"content": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
}
}
},
"ClientPolicy": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"policyId": { "type": "integer", "format": "int32" }
}
},
"IDivisionContext": {
"type": "object",
"properties": {
"appUserMap": {
"type": "object",
"additionalProperties": { "$ref": "#/components/schemas/AppUser" }
},
"divisionWAMPShard": { "type": "integer", "format": "int32" },
"divisionUid": { "type": "string", "format": "uuid" },
"division": {
"type": "object",
"properties": {
"uid": { "type": "string", "format": "uuid" },
"localizedDateTimeFormatterLong": {
"type": "object",
"properties": {
"locale": {
"type": "object",
"properties": {
"language": { "type": "string" },
"script": { "type": "string" },
"country": { "type": "string" },
"variant": { "type": "string" },
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"iso3Language": { "type": "string" },
"iso3Country": { "type": "string" },
"displayLanguage": { "type": "string" },
"displayScript": { "type": "string" },
"displayCountry": { "type": "string" },
"displayVariant": { "type": "string" },
"displayName": { "type": "string" }
}
},
"decimalStyle": {
"type": "object",
"properties": {
"zeroDigit": { "type": "string" },
"positiveSign": { "type": "string" },
"negativeSign": { "type": "string" },
"decimalSeparator": { "type": "string" }
}
},
"resolverStyle": { "type": "string", "enum": ["STRICT", "SMART", "LENIENT"] },
"resolverFields": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"baseUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"rangeUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"dateBased": { "type": "boolean" }
}
}
},
"zone": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"properties": {
"fixedOffset": { "type": "boolean" },
"transitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"gap": { "type": "boolean" },
"overlap": { "type": "boolean" },
"dateTimeBefore": { "type": "string", "format": "date-time" },
"dateTimeAfter": { "type": "string", "format": "date-time" },
"instant": { "type": "number", "format": "double" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
}
},
"transitionRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"timeDefinition": {
"type": "string",
"enum": ["UTC", "WALL", "STANDARD"]
},
"standardOffset": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"dayOfWeek": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"dayOfMonthIndicator": { "type": "integer", "format": "int32" },
"localTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"midnightEndOfDay": { "type": "boolean" }
}
}
}
}
},
"id": { "type": "string" }
}
},
"chronology": {
"type": "object",
"properties": {
"calendarType": { "type": "string" },
"id": { "type": "string" }
}
}
}
},
"localizedDateTimeFormatterShort": {
"type": "object",
"properties": {
"locale": {
"type": "object",
"properties": {
"language": { "type": "string" },
"script": { "type": "string" },
"country": { "type": "string" },
"variant": { "type": "string" },
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"iso3Language": { "type": "string" },
"iso3Country": { "type": "string" },
"displayLanguage": { "type": "string" },
"displayScript": { "type": "string" },
"displayCountry": { "type": "string" },
"displayVariant": { "type": "string" },
"displayName": { "type": "string" }
}
},
"decimalStyle": {
"type": "object",
"properties": {
"zeroDigit": { "type": "string" },
"positiveSign": { "type": "string" },
"negativeSign": { "type": "string" },
"decimalSeparator": { "type": "string" }
}
},
"resolverStyle": { "type": "string", "enum": ["STRICT", "SMART", "LENIENT"] },
"resolverFields": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"baseUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"rangeUnit": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
},
"dateBased": { "type": "boolean" }
}
}
},
"zone": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"properties": {
"fixedOffset": { "type": "boolean" },
"transitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"gap": { "type": "boolean" },
"overlap": { "type": "boolean" },
"dateTimeBefore": { "type": "string", "format": "date-time" },
"dateTimeAfter": { "type": "string", "format": "date-time" },
"instant": { "type": "number", "format": "double" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
}
},
"transitionRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"timeDefinition": {
"type": "string",
"enum": ["UTC", "WALL", "STANDARD"]
},
"standardOffset": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"dayOfWeek": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"dayOfMonthIndicator": { "type": "integer", "format": "int32" },
"localTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"midnightEndOfDay": { "type": "boolean" }
}
}
}
}
},
"id": { "type": "string" }
}
},
"chronology": {
"type": "object",
"properties": {
"calendarType": { "type": "string" },
"id": { "type": "string" }
}
}
}
},
"timeZoneId": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"properties": {
"fixedOffset": { "type": "boolean" },
"transitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"gap": { "type": "boolean" },
"overlap": { "type": "boolean" },
"dateTimeBefore": { "type": "string", "format": "date-time" },
"dateTimeAfter": { "type": "string", "format": "date-time" },
"instant": { "type": "number", "format": "double" },
"duration": {
"type": "object",
"properties": {
"seconds": { "type": "integer", "format": "int64" },
"nano": { "type": "integer", "format": "int32" },
"negative": { "type": "boolean" },
"zero": { "type": "boolean" },
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeBased": { "type": "boolean" },
"dateBased": { "type": "boolean" },
"durationEstimated": { "type": "boolean" }
}
}
}
}
}
}
}
},
"transitionRules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "string",
"enum": [
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"timeDefinition": {
"type": "string",
"enum": ["UTC", "WALL", "STANDARD"]
},
"standardOffset": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetBefore": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"offsetAfter": {
"type": "object",
"properties": {
"totalSeconds": { "type": "integer", "format": "int32" },
"id": { "type": "string" }
}
},
"dayOfWeek": {
"type": "string",
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"dayOfMonthIndicator": { "type": "integer", "format": "int32" },
"localTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"midnightEndOfDay": { "type": "boolean" }
}
}
}
}
},
"id": { "type": "string" }
}
},
"timeZone": {
"type": "object",
"properties": {
"dstsavings": { "type": "integer", "format": "int32" },
"rawOffset": { "type": "integer", "format": "int32" },
"id": { "type": "string" },
"displayName": { "type": "string" }
}
},
"calendar": { "type": "string", "format": "date-time" },
"locale": {
"type": "object",
"properties": {
"language": { "type": "string" },
"script": { "type": "string" },
"country": { "type": "string" },
"variant": { "type": "string" },
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string" }
},
"iso3Language": { "type": "string" },
"iso3Country": { "type": "string" },
"displayLanguage": { "type": "string" },
"displayScript": { "type": "string" },
"displayCountry": { "type": "string" },
"displayVariant": { "type": "string" },
"displayName": { "type": "string" }
}
},
"brandingEnabled": { "type": "boolean" },
"email": { "type": "string" },
"companyName": { "type": "string" },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"phone": { "type": "string" },
"created": { "type": "number", "format": "double" },
"dbName": { "type": "string" },
"trialLicense": { "type": "boolean" },
"licenseExpiration": { "type": "number", "format": "double" },
"engaged": { "type": "number", "format": "double" },
"reportingKey": { "type": "string", "format": "uuid" },
"timeZoneIdString": { "type": "string" },
"languageTag": { "type": "string" },
"contentNode": { "type": "object", "additionalProperties": true },
"locallyEngaged": { "type": "number", "format": "double" },
"brandingNode": { "type": "object", "additionalProperties": true },
"hostname": { "type": "string" },
"state": {
"type": "string",
"enum": [
"UNKNOWN",
"ACTIVE",
"SUSPENDED",
"ARCHIVED",
"ACCESS_RESTRICTED",
"MAINTENANCE",
"MIGRATING",
"MOVED"
]
},
"zone": { "type": "string" },
"dbHost": { "type": "string" },
"dataKey": { "type": "string" },
"securityNode": { "type": "object", "additionalProperties": true },
"region": { "type": "string" },
"ticketingEmailDomain": {
"type": "object",
"properties": {
"domain": { "type": "string" },
"fromEmailDomain": { "type": "string" },
"useFromEmailDomain": { "type": "boolean" }
}
},
"parentDivisionUid": { "type": "string", "format": "uuid" },
"enabledFeatures": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"rdp",
"cbS3Stats",
"vmware",
"cloudberry",
"Ticketing",
"ninja_control",
"remotesupport",
"macff",
"desktopcompanion",
"override_remote_client_ip",
"documentation",
"hyperv",
"ad_management",
"ninja_psa",
"ad_discovery",
"user_permission",
"notification_channels",
"mdm",
"custom_snmp",
"ticketing_mobile",
"cloud_image_mounting",
"legacy_backup_products",
"template_library",
"device_dashboard_show_task_membership",
"skip_mfa"
]
}
},
"companyDisplayName": { "type": "string" },
"additionalHostnames": { "type": "array", "items": { "type": "string" } },
"ninjaId": { "type": "string" },
"salesforceId": { "type": "string" },
"ipsubnetWhitelist": { "type": "array", "items": { "type": "object" } },
"expired": { "type": "boolean" },
"new": { "type": "boolean" }
}
},
"divisionUidAsString": { "type": "string" },
"divisionFeatures": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"rdp",
"cbS3Stats",
"vmware",
"cloudberry",
"Ticketing",
"ninja_control",
"remotesupport",
"macff",
"desktopcompanion",
"override_remote_client_ip",
"documentation",
"hyperv",
"ad_management",
"ninja_psa",
"ad_discovery",
"user_permission",
"notification_channels",
"mdm",
"custom_snmp",
"ticketing_mobile",
"cloud_image_mounting",
"legacy_backup_products",
"template_library",
"device_dashboard_show_task_membership",
"skip_mfa"
]
}
},
"nodeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } },
"clientList": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } },
"remoteSupportClients": {
"type": "array",
"items": { "$ref": "#/components/schemas/Client" }
},
"clientLocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"address": { "type": "string" },
"description": { "type": "string" },
"userData": { "type": "object", "additionalProperties": true },
"psaLocationId": { "type": "integer", "format": "int32" },
"psaLocationName": { "type": "string" },
"clientId": { "type": "integer", "format": "int32" },
"default": { "type": "boolean" },
"locationContent": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
},
"networkLocationEnabled": { "type": "boolean" },
"content": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
}
}
}
},
"clientLocationsById": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"address": { "type": "string" },
"description": { "type": "string" },
"userData": { "type": "object", "additionalProperties": true },
"psaLocationId": { "type": "integer", "format": "int32" },
"psaLocationName": { "type": "string" },
"clientId": { "type": "integer", "format": "int32" },
"default": { "type": "boolean" },
"locationContent": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
},
"networkLocationEnabled": { "type": "boolean" },
"content": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
}
}
}
},
"nodesWithUpdatedVolatileProperties": {
"type": "array",
"items": { "$ref": "#/components/schemas/Node" }
}
}
},
"IPAddressMatcher": { "type": "object" },
"LocalTime": {
"type": "object",
"properties": {
"hour": { "type": "integer", "format": "int32" },
"minute": { "type": "integer", "format": "int32" },
"second": { "type": "integer", "format": "int32" },
"nano": { "type": "integer", "format": "int32" }
}
},
"LocationContent": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
},
"Node": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"nodeRole": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": { "type": "number", "description": "Date created", "format": "double" },
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
},
"description": "Device Role"
},
"clientId": { "type": "integer", "format": "int32" },
"policyId": { "type": "integer", "format": "int32" },
"dnsName": { "type": "string" },
"systemName": { "type": "string" },
"netbiosName": { "type": "string" },
"friendlyName": { "type": "string" },
"ipAddress": {
"type": "object",
"properties": {
"canonicalHostName": { "type": "string" },
"multicastAddress": { "type": "boolean" },
"anyLocalAddress": { "type": "boolean" },
"loopbackAddress": { "type": "boolean" },
"linkLocalAddress": { "type": "boolean" },
"siteLocalAddress": { "type": "boolean" },
"mcglobal": { "type": "boolean" },
"mcnodeLocal": { "type": "boolean" },
"mclinkLocal": { "type": "boolean" },
"mcsiteLocal": { "type": "boolean" },
"mcorgLocal": { "type": "boolean" },
"address": { "type": "array", "items": { "type": "string", "format": "byte" } },
"hostAddress": { "type": "string" },
"hostName": { "type": "string" }
}
},
"nodeType": {
"type": "string",
"enum": [
"AGENT",
"CLOUD_MONITOR_TARGET",
"NMS_SERVER",
"NMS_TARGET",
"VMM_TARGET",
"CLOUD_MONITOR_TARGET_EMAIL_SERVER",
"MOBILE_TARGET"
]
},
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"chassisType": { "type": "string", "enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"] },
"submitTime": { "type": "number", "format": "double" },
"contactTime": { "type": "number", "format": "double" },
"offline": { "type": "boolean" },
"parentNodeId": { "type": "integer", "format": "int32" },
"onlineStatus": {
"type": "string",
"enum": ["OFFLINE", "ONLINE", "CONNECTED", "SLEEPING", "UPGRADING", "REBOOTING"]
},
"locationId": { "type": "integer", "format": "int32" },
"created": { "type": "number", "format": "double" },
"description": { "type": "string" },
"approvalStatus": { "type": "string", "enum": ["PENDING", "APPROVED"] },
"responsibilities": {
"type": "array",
"items": { "type": "string", "enum": ["RMM_AGENT", "VMM_AGENT", "NM_AGENT"] }
},
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"client": { "$ref": "#/components/schemas/Client" },
"needsReload": { "type": "boolean", "writeOnly": true },
"machineId": { "type": "string" },
"content": { "type": "string" },
"policyContent": { "type": "string" },
"agentSettings": { "type": "string" },
"monitorServerSettings": { "type": "string" },
"nmsServerSettings": { "type": "string" },
"offlineEvaluationStatus": {
"type": "string",
"enum": ["NOT_APPLICABLE", "PENDING", "PROCESSING", "COMPLETE_TRIGGERED"]
},
"approvalStatusByAppUserId": { "type": "integer", "format": "int32" },
"approvalStatusByAppUserName": { "type": "string" },
"approvalStatusTime": { "type": "number", "format": "double" },
"userData": { "type": "object", "additionalProperties": true },
"nodeMaintenanceInfo": {
"type": "object",
"properties": {
"startTime": { "type": "number", "format": "double" },
"endTime": { "type": "number", "format": "double" },
"agentMaintenanceStatus": {
"type": "string",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED_TO_ENTER_MAINTENANCE"]
},
"disabledOptions": { "type": "array", "items": { "type": "string" } }
}
},
"isWAMPRegistered": { "type": "boolean" },
"currentSessionId": { "type": "string", "format": "uuid" },
"publicIP": { "type": "string" },
"credentialsMap": {
"type": "object",
"additionalProperties": { "type": "integer", "format": "int32" }
},
"mdmStatus": {
"type": "string",
"enum": ["PENDING_RELINQUISH", "PENDING_ERASE", "RELINQUISHED", "ERASED"]
},
"name": { "type": "string" },
"disconnectedFromWAMP": { "type": "boolean" },
"connectedToWAMP": { "type": "boolean" },
"agentNode": { "type": "boolean" },
"allAncestors": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/Node" }
},
"parentNode": { "$ref": "#/components/schemas/Node" },
"clientUid": { "type": "string", "format": "uuid" },
"divisionUid": { "type": "string", "format": "uuid" },
"submitDataTeamViewerClientIdParsed": { "type": "boolean" },
"submitDataTeamViewerClientId": { "type": "integer", "format": "int32" },
"displayName": { "type": "string" },
"server": { "type": "boolean" },
"mdmDevice": { "type": "boolean" },
"windowsServer": { "type": "boolean" },
"windowsWorkstation": { "type": "boolean" },
"windowsDesktop": { "type": "boolean" },
"windowsLaptop": { "type": "boolean" },
"nmsServerNode": { "type": "boolean" },
"nmsTargetNode": { "type": "boolean" },
"nmsNode": { "type": "boolean" },
"macServer": { "type": "boolean" },
"macWorkstation": { "type": "boolean" },
"macDesktop": { "type": "boolean" },
"macLaptop": { "type": "boolean" },
"vmwareHost": { "type": "boolean" },
"vmwareVirtualMachine": { "type": "boolean" },
"hyperVHost": { "type": "boolean" },
"hyperVVirtualMachine": { "type": "boolean" },
"linuxServer": { "type": "boolean" },
"androidDevice": { "type": "boolean" },
"linuxWorkstation": { "type": "boolean" },
"linuxDesktop": { "type": "boolean" },
"linuxLaptop": { "type": "boolean" },
"dashboardString": { "type": "string" },
"approved": { "type": "boolean" },
"monitorServerNode": { "type": "boolean" },
"nodeRoleFields": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": { "type": "number", "description": "Date created", "format": "double" },
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
},
"description": "Device Role"
}
}
},
"NodeMaintenanceInfo": {
"type": "object",
"properties": {
"startTime": { "type": "number", "format": "double" },
"endTime": { "type": "number", "format": "double" },
"agentMaintenanceStatus": {
"type": "string",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED_TO_ENTER_MAINTENANCE"]
},
"disabledOptions": { "type": "array", "items": { "type": "string" } }
}
},
"NodeRole": {
"type": "object",
"properties": {
"id": { "type": "integer", "description": "Device Role identifier", "format": "int32" },
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": { "type": "number", "description": "Date created", "format": "double" },
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
},
"description": "Device Role"
},
"NotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
},
"NotificationSchedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": { "type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"] }
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"Ticket": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"version": { "type": "integer", "format": "int32" },
"emailId": { "type": "string" },
"emailAddressConfigId": { "type": "integer", "format": "int32" },
"assignedAppUserId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"nodeId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"clientId": { "type": "integer", "format": "int32" },
"summary": { "type": "string" },
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": { "type": "string", "enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"] },
"source": {
"type": "string",
"enum": [
"TECHNICIAN",
"EMAIL",
"WEB_FORM",
"HELP_REQUEST",
"END_USER",
"CONDITION",
"SCHEDULED_SCRIPT"
]
},
"sourceConfigUid": { "type": "string", "format": "uuid" },
"priority": { "type": "integer", "format": "int32" },
"severity": { "type": "integer", "format": "int32" },
"createTime": { "type": "number", "format": "double" },
"deleted": { "type": "boolean" },
"tags": { "type": "array", "items": { "type": "string" } },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"textValue": { "type": "string" },
"encryptedTextValue": { "type": "string" },
"intValue": { "type": "integer", "format": "int32" },
"floatValue": { "type": "number", "format": "float" },
"datetimeValue": { "type": "number", "format": "double" },
"uuidValue": { "type": "string", "format": "uuid" },
"booleanValue": { "type": "boolean" },
"uuidValues": { "type": "array", "items": { "type": "string", "format": "uuid" } },
"attachmentValue": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
},
"entityValue": {
"type": "object",
"properties": {
"entityId": { "type": "integer", "format": "int32" },
"type": { "type": "string", "enum": ["NODE", "CLIENT", "CLIENT_LOCATION"] }
}
},
"entityValues": {
"type": "object",
"properties": {
"entityIds": {
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"type": { "type": "string", "enum": ["NODE", "CLIENT", "CLIENT_LOCATION"] }
}
},
"wysiwygValue": {
"type": "object",
"properties": {
"text": { "type": "string" },
"html": { "type": "string" },
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
}
}
}
},
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"updatedBy": {
"type": "object",
"properties": {
"source": { "type": "string", "enum": ["API", "USER", "SCRIPT"] },
"user": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" }
}
}
},
"description": "Value source (who/what updated the value)"
},
"value": { "type": "object" }
}
}
},
"ticketForm": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"description": { "type": "string" },
"endUserTitle": { "type": "string" },
"content": {
"type": "object",
"properties": {
"fields": { "type": "array", "items": { "type": "integer", "format": "int32" } },
"timerSettings": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"mode": { "type": "string", "enum": ["MANUAL", "AUTO_START"] }
}
}
}
},
"active": { "type": "boolean" },
"default": { "type": "boolean" },
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"endUserVisible": { "type": "boolean" },
"endUserDefault": { "type": "boolean" },
"mode": { "type": "string", "writeOnly": true, "enum": ["MANUAL", "AUTO_START"] }
}
},
"requester": {
"type": "object",
"properties": {
"uid": { "type": "string", "format": "uuid" },
"clientId": { "type": "integer", "format": "int32" },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"email": { "type": "string" },
"deleted": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER", "CONTACT"] },
"appUser": { "type": "boolean" }
}
},
"assignedAppUser": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"email": { "type": "string" },
"phone": { "type": "string" },
"phoneVerified": { "type": "boolean", "writeOnly": true },
"firstName": { "type": "string" },
"lastName": { "type": "string" },
"password": { "type": "string" },
"mustChangePw": { "type": "boolean" },
"enabled": { "type": "boolean" },
"contentNode": { "type": "object", "additionalProperties": true },
"ninjaAdmin": { "type": "boolean" },
"sysadmin": { "type": "boolean" },
"permitAllClients": { "type": "boolean" },
"notifyAllClients": { "type": "boolean" },
"masterMspUser": { "type": "boolean" },
"userType": { "type": "string", "enum": ["TECHNICIAN", "END_USER"] },
"clientId": { "type": "integer", "format": "int32" },
"favorites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
}
},
"recents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GROUP",
"CUSTOMER",
"TICKET",
"DEVICE",
"VM",
"VM_HOST",
"VM_GUEST",
"MONITOR",
"NMS"
]
},
"id": { "type": "integer", "format": "int32" }
}
}
},
"authenticationType": { "type": "string", "enum": ["NATIVE", "SSO"] },
"roleIds": {
"uniqueItems": true,
"type": "array",
"items": { "type": "integer", "format": "int32" }
},
"ownerRoleId": { "type": "integer", "format": "int32" },
"appUserClientMap": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"permit": { "type": "boolean" },
"notify": { "type": "boolean" }
}
}
},
"fileFolderBackupAllowed": { "type": "boolean" },
"emailNotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
},
"u2FTokenCount": { "type": "integer", "format": "int32" },
"pwResetTime": { "type": "number", "format": "double" },
"invitationAcceptedTime": { "type": "number", "format": "double" },
"name": { "type": "string" },
"displayName": { "type": "string" },
"ticketingAdmin": { "type": "boolean" },
"phoneMasked": { "type": "string" },
"smsotpconfigured": { "type": "boolean" },
"totpconfigured": { "type": "boolean" },
"u2FConfigured": { "type": "boolean" },
"plainPassword": { "type": "string", "writeOnly": true },
"emailFormatLegacy": { "type": "boolean" },
"mfaconfigured": { "type": "boolean" },
"invitationAccepted": { "type": "boolean" },
"globalEndUser": { "type": "boolean" },
"technician": { "type": "boolean" },
"endUser": { "type": "boolean" },
"divisionContext": { "$ref": "#/components/schemas/IDivisionContext" },
"preferredMFAType": {
"type": "string",
"enum": ["NONE", "TOTP", "SMSOTP", "U2F_TOKEN"]
},
"smsnotificationPreferences": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"minSeverity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"minPriority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"schedule": {
"type": "object",
"properties": {
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
}
},
"startHour": { "type": "integer", "format": "int32" },
"endHour": { "type": "integer", "format": "int32" }
}
},
"timeZone": { "type": "string" }
}
}
}
},
"client": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"name": { "type": "string" },
"description": { "type": "string" },
"psaId": { "type": "integer", "format": "int64" },
"psaName": { "type": "string" },
"folderUid": { "type": "string", "format": "uuid" },
"inHouse": { "type": "boolean" },
"contentNode": { "type": "object", "additionalProperties": true },
"defaultLocationId": { "type": "integer", "format": "int32" },
"userData": { "type": "object", "additionalProperties": true },
"remoteSupportFolder": { "type": "boolean" },
"clientPolicyList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clientId": { "type": "integer", "format": "int32" },
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"policyId": { "type": "integer", "format": "int32" }
}
}
},
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"credentialsMap": {
"type": "object",
"additionalProperties": { "type": "integer", "format": "int32" }
},
"approvalMode": { "type": "string", "enum": ["AUTOMATIC", "MANUAL", "REJECT"] },
"valid": { "type": "boolean" },
"content": { "type": "string" },
"connectWiseNode": { "type": "object", "additionalProperties": true },
"psaIdAsInt": { "type": "integer", "format": "int32" },
"productCode": {
"type": "string",
"enum": [
"SHADOWPROTECT",
"IMAGEMANAGER",
"VIPRE",
"SPLASHTOP",
"CLOUDBERRY",
"WEBROOT",
"BITDEFENDER",
"LOCKHART",
"CONNECTWISE"
]
},
"validForPsaTicketCreate": { "type": "boolean" }
}
},
"location": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"address": { "type": "string" },
"description": { "type": "string" },
"userData": { "type": "object", "additionalProperties": true },
"psaLocationId": { "type": "integer", "format": "int32" },
"psaLocationName": { "type": "string" },
"clientId": { "type": "integer", "format": "int32" },
"default": { "type": "boolean" },
"locationContent": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
},
"networkLocationEnabled": { "type": "boolean" },
"content": {
"type": "object",
"properties": {
"patching": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"backup": {
"type": "object",
"properties": { "networkLocationEnabled": { "type": "boolean" } }
}
}
}
}
},
"node": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"uid": { "type": "string", "format": "uuid" },
"nodeRole": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
},
"description": "Device Role"
},
"clientId": { "type": "integer", "format": "int32" },
"policyId": { "type": "integer", "format": "int32" },
"dnsName": { "type": "string" },
"systemName": { "type": "string" },
"netbiosName": { "type": "string" },
"friendlyName": { "type": "string" },
"ipAddress": {
"type": "object",
"properties": {
"canonicalHostName": { "type": "string" },
"multicastAddress": { "type": "boolean" },
"anyLocalAddress": { "type": "boolean" },
"loopbackAddress": { "type": "boolean" },
"linkLocalAddress": { "type": "boolean" },
"siteLocalAddress": { "type": "boolean" },
"mcglobal": { "type": "boolean" },
"mcnodeLocal": { "type": "boolean" },
"mclinkLocal": { "type": "boolean" },
"mcsiteLocal": { "type": "boolean" },
"mcorgLocal": { "type": "boolean" },
"address": { "type": "array", "items": { "type": "string", "format": "byte" } },
"hostAddress": { "type": "string" },
"hostName": { "type": "string" }
}
},
"nodeType": {
"type": "string",
"enum": [
"AGENT",
"CLOUD_MONITOR_TARGET",
"NMS_SERVER",
"NMS_TARGET",
"VMM_TARGET",
"CLOUD_MONITOR_TARGET_EMAIL_SERVER",
"MOBILE_TARGET"
]
},
"nodeRoleId": { "type": "integer", "format": "int32" },
"nodeClass": {
"type": "string",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"chassisType": {
"type": "string",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"submitTime": { "type": "number", "format": "double" },
"contactTime": { "type": "number", "format": "double" },
"offline": { "type": "boolean" },
"parentNodeId": { "type": "integer", "format": "int32" },
"onlineStatus": {
"type": "string",
"enum": ["OFFLINE", "ONLINE", "CONNECTED", "SLEEPING", "UPGRADING", "REBOOTING"]
},
"locationId": { "type": "integer", "format": "int32" },
"created": { "type": "number", "format": "double" },
"description": { "type": "string" },
"approvalStatus": { "type": "string", "enum": ["PENDING", "APPROVED"] },
"responsibilities": {
"type": "array",
"items": { "type": "string", "enum": ["RMM_AGENT", "VMM_AGENT", "NM_AGENT"] }
},
"divisionContainer": { "$ref": "#/components/schemas/IDivisionContext" },
"client": { "$ref": "#/components/schemas/Client" },
"needsReload": { "type": "boolean", "writeOnly": true },
"machineId": { "type": "string" },
"content": { "type": "string" },
"policyContent": { "type": "string" },
"agentSettings": { "type": "string" },
"monitorServerSettings": { "type": "string" },
"nmsServerSettings": { "type": "string" },
"offlineEvaluationStatus": {
"type": "string",
"enum": ["NOT_APPLICABLE", "PENDING", "PROCESSING", "COMPLETE_TRIGGERED"]
},
"approvalStatusByAppUserId": { "type": "integer", "format": "int32" },
"approvalStatusByAppUserName": { "type": "string" },
"approvalStatusTime": { "type": "number", "format": "double" },
"userData": { "type": "object", "additionalProperties": true },
"nodeMaintenanceInfo": {
"type": "object",
"properties": {
"startTime": { "type": "number", "format": "double" },
"endTime": { "type": "number", "format": "double" },
"agentMaintenanceStatus": {
"type": "string",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED_TO_ENTER_MAINTENANCE"]
},
"disabledOptions": { "type": "array", "items": { "type": "string" } }
}
},
"isWAMPRegistered": { "type": "boolean" },
"currentSessionId": { "type": "string", "format": "uuid" },
"publicIP": { "type": "string" },
"credentialsMap": {
"type": "object",
"additionalProperties": { "type": "integer", "format": "int32" }
},
"mdmStatus": {
"type": "string",
"enum": ["PENDING_RELINQUISH", "PENDING_ERASE", "RELINQUISHED", "ERASED"]
},
"name": { "type": "string" },
"disconnectedFromWAMP": { "type": "boolean" },
"connectedToWAMP": { "type": "boolean" },
"agentNode": { "type": "boolean" },
"allAncestors": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/Node" }
},
"parentNode": { "$ref": "#/components/schemas/Node" },
"clientUid": { "type": "string", "format": "uuid" },
"divisionUid": { "type": "string", "format": "uuid" },
"submitDataTeamViewerClientIdParsed": { "type": "boolean" },
"submitDataTeamViewerClientId": { "type": "integer", "format": "int32" },
"displayName": { "type": "string" },
"server": { "type": "boolean" },
"mdmDevice": { "type": "boolean" },
"windowsServer": { "type": "boolean" },
"windowsWorkstation": { "type": "boolean" },
"windowsDesktop": { "type": "boolean" },
"windowsLaptop": { "type": "boolean" },
"nmsServerNode": { "type": "boolean" },
"nmsTargetNode": { "type": "boolean" },
"nmsNode": { "type": "boolean" },
"macServer": { "type": "boolean" },
"macWorkstation": { "type": "boolean" },
"macDesktop": { "type": "boolean" },
"macLaptop": { "type": "boolean" },
"vmwareHost": { "type": "boolean" },
"vmwareVirtualMachine": { "type": "boolean" },
"hyperVHost": { "type": "boolean" },
"hyperVVirtualMachine": { "type": "boolean" },
"linuxServer": { "type": "boolean" },
"androidDevice": { "type": "boolean" },
"linuxWorkstation": { "type": "boolean" },
"linuxDesktop": { "type": "boolean" },
"linuxLaptop": { "type": "boolean" },
"dashboardString": { "type": "string" },
"approved": { "type": "boolean" },
"monitorServerNode": { "type": "boolean" },
"nodeRoleFields": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
}
},
"description": "Device Role"
}
}
},
"ticketRelationsByTicketRight": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/TicketRelation" }
},
"ticketRelationsByTicketLeft": {
"uniqueItems": true,
"type": "array",
"items": { "$ref": "#/components/schemas/TicketRelation" }
},
"solved": { "type": "boolean" },
"notModifiable": { "type": "boolean" }
}
},
"TicketAttributeValue": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"textValue": { "type": "string" },
"encryptedTextValue": { "type": "string" },
"intValue": { "type": "integer", "format": "int32" },
"floatValue": { "type": "number", "format": "float" },
"datetimeValue": { "type": "number", "format": "double" },
"uuidValue": { "type": "string", "format": "uuid" },
"booleanValue": { "type": "boolean" },
"uuidValues": { "type": "array", "items": { "type": "string", "format": "uuid" } },
"attachmentValue": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
},
"entityValue": {
"type": "object",
"properties": {
"entityId": { "type": "integer", "format": "int32" },
"type": { "type": "string", "enum": ["NODE", "CLIENT", "CLIENT_LOCATION"] }
}
},
"entityValues": {
"type": "object",
"properties": {
"entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } },
"type": { "type": "string", "enum": ["NODE", "CLIENT", "CLIENT_LOCATION"] }
}
},
"wysiwygValue": {
"type": "object",
"properties": {
"text": { "type": "string" },
"html": { "type": "string" },
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": { "type": "string" },
"size": { "type": "integer", "format": "int64" },
"mimeType": { "type": "string" },
"resourceId": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" }
}
}
}
}
},
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"updatedBy": {
"type": "object",
"properties": {
"source": { "type": "string", "enum": ["API", "USER", "SCRIPT"] },
"user": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" }
}
}
},
"description": "Value source (who/what updated the value)"
},
"value": { "type": "object" }
}
},
"TicketForm": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" },
"description": { "type": "string" },
"endUserTitle": { "type": "string" },
"content": {
"type": "object",
"properties": {
"fields": { "type": "array", "items": { "type": "integer", "format": "int32" } },
"timerSettings": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"mode": { "type": "string", "enum": ["MANUAL", "AUTO_START"] }
}
}
}
},
"active": { "type": "boolean" },
"default": { "type": "boolean" },
"createTime": { "type": "number", "format": "double" },
"updateTime": { "type": "number", "format": "double" },
"endUserVisible": { "type": "boolean" },
"endUserDefault": { "type": "boolean" },
"mode": { "type": "string", "writeOnly": true, "enum": ["MANUAL", "AUTO_START"] }
}
},
"TicketFormContent": {
"type": "object",
"properties": {
"fields": { "type": "array", "items": { "type": "integer", "format": "int32" } },
"timerSettings": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"mode": { "type": "string", "enum": ["MANUAL", "AUTO_START"] }
}
}
}
},
"TicketRelation": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"ticketLeftId": { "type": "integer", "format": "int32" },
"ticketRightId": { "type": "integer", "format": "int32" },
"type": { "type": "string", "enum": ["INCIDENT"] },
"createTime": { "type": "number", "format": "double" },
"ticketLeft": { "$ref": "#/components/schemas/Ticket" },
"ticketRight": { "$ref": "#/components/schemas/Ticket" }
}
},
"TicketingEmailDomain": {
"type": "object",
"properties": {
"domain": { "type": "string" },
"fromEmailDomain": { "type": "string" },
"useFromEmailDomain": { "type": "boolean" }
}
},
"TimerSettings": {
"type": "object",
"properties": {
"enabled": { "type": "boolean" },
"mode": { "type": "string", "enum": ["MANUAL", "AUTO_START"] }
}
},
"UserBasicInfo": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"name": { "type": "string" }
}
},
"WSUSSettings": {
"type": "object",
"properties": {
"hostname": { "type": "string" },
"port": { "type": "string" },
"secure": { "type": "boolean" },
"useCloud": { "type": "boolean" },
"wsusEnabled": { "type": "boolean" }
}
},
"AttachmentMetadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
},
"AttributeValue": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"value": { "type": "string" }
}
},
"NewTicketLogEntry": {
"type": "object",
"properties": {
"public": { "type": "boolean" },
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"uploads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": { "type": "string" },
"metadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
}
}
}
},
"timeTracked": { "type": "integer", "format": "int32" },
"duplicateInIncidents": { "type": "boolean" }
}
},
"TicketAttachmentInput": {
"type": "object",
"properties": {
"resourceId": { "type": "string" },
"metadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
}
}
},
"UpdateTicket": {
"type": "object",
"properties": {
"requestUid": { "type": "string", "format": "uuid" },
"version": { "type": "integer", "format": "int32" },
"clientId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"nodeId": { "type": "integer", "format": "int32" },
"summary": { "maxLength": 200, "minLength": 0, "type": "string" },
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": { "type": "string", "enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"] },
"assignedAppUserId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"value": { "type": "string" }
}
}
},
"severity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"tags": { "type": "array", "items": { "type": "string" } },
"parentTicketId": { "type": "integer", "format": "int32" }
}
},
"UpdateTicketWithComment": {
"type": "object",
"properties": {
"ticket": {
"type": "object",
"properties": {
"requestUid": { "type": "string", "format": "uuid" },
"version": { "type": "integer", "format": "int32" },
"clientId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"nodeId": { "type": "integer", "format": "int32" },
"summary": { "maxLength": 200, "minLength": 0, "type": "string" },
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": { "type": "string", "enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"] },
"assignedAppUserId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"value": { "type": "string" }
}
}
},
"severity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"tags": { "type": "array", "items": { "type": "string" } },
"parentTicketId": { "type": "integer", "format": "int32" }
}
},
"comment": {
"type": "object",
"properties": {
"public": { "type": "boolean" },
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"uploads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": { "type": "string" },
"metadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
}
}
}
},
"timeTracked": { "type": "integer", "format": "int32" },
"duplicateInIncidents": { "type": "boolean" }
}
}
}
},
"NewTicketRequest": {
"type": "object",
"properties": {
"requestUid": { "type": "string", "format": "uuid" },
"clientId": { "type": "integer", "format": "int32" },
"ticketFormId": { "type": "integer", "format": "int32" },
"locationId": { "type": "integer", "format": "int32" },
"nodeId": { "type": "integer", "format": "int32" },
"summary": { "maxLength": 200, "minLength": 0, "type": "string" },
"description": {
"type": "object",
"properties": {
"public": { "type": "boolean" },
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"uploads": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": { "type": "string" },
"metadata": {
"type": "object",
"properties": {
"name": { "type": "string" },
"mimeType": { "type": "string" },
"size": { "type": "string" },
"extension": { "type": "string" },
"contentId": { "type": "string" },
"inline": { "type": "boolean" }
}
}
}
}
},
"timeTracked": { "type": "integer", "format": "int32" },
"duplicateInIncidents": { "type": "boolean" }
}
},
"status": {
"type": "string",
"enum": ["NEW", "OPEN", "WAITING", "PAUSED", "RESOLVED", "CLOSED"]
},
"type": { "type": "string", "enum": ["PROBLEM", "QUESTION", "INCIDENT", "TASK"] },
"assignedAppUserId": { "type": "integer", "format": "int32" },
"requesterUid": { "type": "string", "format": "uuid" },
"ccList": {
"type": "object",
"properties": {
"uids": {
"uniqueItems": true,
"type": "array",
"items": { "type": "string", "format": "uuid" }
},
"emails": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }
}
},
"attributeValues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"attributeId": { "type": "integer", "format": "int32" },
"value": { "type": "string" }
}
}
},
"severity": {
"type": "string",
"enum": ["NONE", "MINOR", "MODERATE", "MAJOR", "CRITICAL"]
},
"priority": { "type": "string", "enum": ["NONE", "LOW", "MEDIUM", "HIGH"] },
"tags": { "type": "array", "items": { "type": "string" } },
"parentTicketId": { "type": "integer", "format": "int32" }
}
},
"TicketLogEntryDTO": {
"type": "object",
"properties": {
"id": { "type": "integer", "format": "int32" },
"appUserContactUid": { "type": "string", "format": "uuid" },
"type": {
"type": "string",
"enum": ["DESCRIPTION", "COMMENT", "CONDITION", "SAVE", "DELETE"]
},
"body": { "type": "string" },
"htmlBody": { "type": "string" },
"fullEmailBody": { "type": "string" },
"publicEntry": { "type": "boolean" },
"System": { "type": "boolean" },
"createTime": { "type": "number", "format": "double" },
"changeDiff": { "type": "object" },
"activityId": { "type": "integer", "format": "int64" },
"timeTracked": { "type": "integer", "format": "int32" },
"emailResponse": { "type": "boolean" }
}
},
"DeviceMutableProperties": {
"type": "object",
"properties": {
"displayName": { "type": "string", "description": "Display name (User assigned)" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping, or reverts to organization policy if Null)",
"format": "int32"
}
}
},
"AgentDevice": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
},
{
"type": "object",
"properties": {
"os": {
"type": "object",
"properties": {
"manufacturer": { "type": "string", "description": "Manufacturer" },
"name": { "type": "string", "description": "Name" },
"architecture": { "type": "string", "description": "Architecture" },
"lastBootTime": {
"type": "number",
"description": "Last boot time",
"format": "double"
},
"buildNumber": { "type": "string", "description": "Build number" },
"releaseId": { "type": "string", "description": "Release ID" },
"servicePackMajorVersion": {
"type": "integer",
"description": "Service Pack Major Version",
"format": "int32"
},
"servicePackMinorVersion": {
"type": "integer",
"description": "Service Pack Minor Version",
"format": "int32"
},
"locale": { "type": "string", "description": "Locale" },
"language": { "type": "string", "description": "Language" },
"needsReboot": {
"type": "boolean",
"description": "Operating system has pending reboot requests"
}
},
"description": "Operating System"
},
"System": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"manufacturer": { "type": "string", "description": "Manufacturer" },
"model": { "type": "string", "description": "Model" },
"biosSerialNumber": { "type": "string", "description": "Bios Serial Number" },
"serialNumber": { "type": "string", "description": "Serial Number" },
"domain": { "type": "string" },
"domainRole": { "type": "string" },
"numberOfProcessors": { "type": "integer", "format": "int32" },
"totalPhysicalMemory": { "type": "integer", "format": "int64" },
"virtualMachine": { "type": "boolean" },
"chassisType": { "type": "string" }
},
"description": "Computer System (Chassis)"
},
"memory": {
"type": "object",
"properties": {
"capacity": { "type": "integer", "description": "Capacity", "format": "int64" }
},
"description": "Memory information"
},
"processors": {
"type": "array",
"description": "Processors",
"items": {
"type": "object",
"properties": {
"architecture": { "type": "string", "description": "Architecture" },
"maxClockSpeed": {
"type": "integer",
"description": "Max Clock Speed",
"format": "int64"
},
"clockSpeed": {
"type": "integer",
"description": "Current Clock Speed",
"format": "int64"
},
"name": { "type": "string", "description": "Name" },
"numCores": {
"type": "integer",
"description": "Number of Cores",
"format": "int32"
},
"numLogicalCores": {
"type": "integer",
"description": "Number of Logical Cores]",
"format": "int32"
}
},
"description": "Processors"
}
},
"volumes": {
"type": "array",
"description": "Disk Volumes",
"items": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"driveLetter": { "type": "string", "description": "Drive Letter" },
"label": { "type": "string", "description": "Volume Label" },
"deviceType": { "type": "string", "description": "Device Type" },
"fileSystem": { "type": "string", "description": "File System Type" },
"autoMount": { "type": "boolean", "description": "Automatically Mounted" },
"compressed": { "type": "boolean", "description": "Compressed" },
"capacity": {
"type": "integer",
"description": "Capacity (bytes)",
"format": "int64"
},
"freeSpace": {
"type": "integer",
"description": "Free Space (bytes)",
"format": "int64"
},
"serialNumber": { "type": "string", "description": "Serial Number" },
"bitLockerStatus": {
"type": "object",
"properties": {
"conversionStatus": {
"type": "string",
"description": "Volume encryption or decryption status.",
"enum": [
"FULLY_DECRYPTED",
"FULLY_ENCRYPTED",
"ENCRYPTION_IN_PROGRESS",
"DECRYPTION_IN_PROGRESS",
"ENCRYPTION_PAUSED",
"DECRYPTION_PAUSED",
"UNKNOWN"
]
},
"encryptionMethod": {
"type": "string",
"description": "Indicated the encryption algorithm and key size used on the volume",
"enum": [
"NONE",
"AES_128_WITH_DIFFUSER",
"AES_256_WITH_DIFFUSER",
"AES_128",
"AES_256",
"HARDWARE_ENCRYPTION",
"XTS_AES_128",
"XTS_AES_256",
"UNKNOWN"
]
},
"protectionStatus": {
"type": "string",
"description": " indicates whether the volume and its encryption key (if any) are secured.",
"enum": ["UNPROTECTED", "PROTECTED", "UNKNOWN", "PENDING"]
},
"lockStatus": {
"type": "string",
"description": "Indicates whether the contents of the volume are accessible from Windows",
"enum": ["UNKNOWN", "UNLOCKED", "LOCKED"]
},
"initializedForProtection": {
"type": "boolean",
"description": "Is initialized for protection"
}
},
"description": "BitLocker Status"
}
},
"description": "Disk Volumes"
}
},
"lastLoggedInUser": {
"type": "string",
"description": "Username that logged in most recently"
}
}
}
]
},
"CloudMonitorDNS": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
},
{
"type": "object",
"properties": {
"enabled": { "type": "boolean", "description": "Is enabled?" },
"interval": {
"type": "integer",
"description": "Monitoring interval (seconds)",
"format": "int32"
},
"timeout": {
"type": "integer",
"description": "Timeout (seconds)",
"format": "int32"
},
"target": {
"type": "string",
"description": "Monitoring target (hostname, IP address or URL)"
}
}
}
]
},
"CloudMonitorEmailServer": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
},
{
"type": "object",
"properties": {
"enabled": { "type": "boolean", "description": "Is enabled?" },
"interval": {
"type": "integer",
"description": "Monitoring interval (seconds)",
"format": "int32"
},
"timeout": {
"type": "integer",
"description": "Timeout (seconds)",
"format": "int32"
},
"target": { "type": "string", "description": "SMTP Host (hostname or IP address)" },
"smtpPort": { "type": "integer", "description": "SMTP Port", "format": "int32" },
"senderEmail": { "type": "string", "description": "Sender's email (FROM)" },
"recipientEmail": { "type": "string", "description": "Recipient's email (TO)" }
}
}
]
},
"CloudMonitorHTTP": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
},
{
"type": "object",
"properties": {
"enabled": { "type": "boolean", "description": "Is enabled?" },
"interval": {
"type": "integer",
"description": "Monitoring interval (seconds)",
"format": "int32"
},
"timeout": {
"type": "integer",
"description": "Timeout (seconds)",
"format": "int32"
},
"target": {
"type": "string",
"description": "Monitoring target (hostname, IP address or URL)"
}
}
}
]
},
"CloudMonitorPing": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
},
{
"type": "object",
"properties": {
"enabled": { "type": "boolean", "description": "Is enabled?" },
"interval": {
"type": "integer",
"description": "Monitoring interval (seconds)",
"format": "int32"
},
"timeout": {
"type": "integer",
"description": "Timeout (seconds)",
"format": "int32"
},
"target": {
"type": "string",
"description": "Monitoring target (hostname, IP address or URL)"
}
}
}
]
},
"CloudMonitorPortScan": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Node (Device) identifier",
"format": "int32"
},
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
"enum": ["PENDING", "APPROVED"]
},
"offline": { "type": "boolean", "description": "Is Offline?" },
"displayName": { "type": "string", "description": "Display Name" },
"systemName": { "type": "string", "description": "System Name" },
"dnsName": { "type": "string", "description": "DNS Name" },
"netbiosName": { "type": "string", "description": "NETBIOS Name" },
"created": { "type": "number", "description": "Created", "format": "double" },
"lastContact": {
"type": "number",
"description": "Last Contact",
"format": "double"
},
"lastUpdate": {
"type": "number",
"description": "Last data submission timestamp",
"format": "double"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": { "type": "object", "description": "Custom Fields" },
"description": "Custom Fields"
},
"maintenance": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Maintenance mode status",
"enum": ["PENDING", "IN_MAINTENANCE", "FAILED"]
},
"start": {
"type": "number",
"description": "Maintenance mode start time",
"format": "double"
},
"end": {
"type": "number",
"description": "Maintenance mode end time",
"format": "double"
}
},
"description": "Maintenance mode status"
},
"references": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Organization full name" },
"description": {
"type": "string",
"description": "Organization Description"
},
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"nodeApprovalMode": {
"type": "string",
"description": "Device Approval Mode",
"enum": ["AUTOMATIC", "MANUAL", "REJECT"]
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
}
}
},
"location": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Location name" },
"address": { "type": "string", "description": "Address" },
"description": { "type": "string", "description": "Description" },
"userData": {
"type": "object",
"additionalProperties": true,
"description": "Custom attributes"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
},
"id": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
}
},
"description": "Location"
},
"rolePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Policy identifier",
"format": "int32"
},
"parentPolicyId": {
"type": "integer",
"description": "Parent Policy identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"updated": {
"type": "number",
"description": "Last update timestamp",
"format": "double"
},
"nodeClassDefault": {
"type": "boolean",
"description": "Is Default Policy for Node Class"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Assigned policy ID (overrides organization policy mapping)"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Device Role identifier",
"format": "int32"
},
"name": { "type": "string", "description": "Name" },
"description": { "type": "string", "description": "Description" },
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"custom": { "type": "boolean", "description": "Is custom node role?" },
"chassisType": {
"type": "string",
"description": "Chassis Type",
"enum": ["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]
},
"created": {
"type": "number",
"description": "Date created",
"format": "double"
},
"tags": {
"type": "array",
"description": "Tags",
"items": { "type": "string", "description": "Tags" }
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Custom Fields"
},
"description": "Custom Fields"
}
},
"description": "Device Role"
}
},
"description": "Expanded entity references"
},
"ipAddresses": {
"type": "array",
"description": "Device IP addresses",
"items": { "type": "string", "description": "Device IP addresses" }
},
"macAddresses": {
"type": "array",
"description": "Device MAC addresses",
"items": { "type": "string", "description": "Device MAC addresses" }
},
"publicIP": { "type": "string", "description": "Device Public IP Address" },
"notes": {
"type": "array",
"description": "Device Notes",
"items": {
"type": "object",
"properties": { "text": { "type": "string", "description": "Note text" } },
"description": "Device Notes"
}
},
"deviceType": { "type": "string" }
},
"discriminator": { "propertyName": "deviceType" }
},
{
"type": "object",
"properties": {
"enabled": { "type": "boolean", "description": "Is enabled?" },
"interval": {
"type": "integer",
"description": "Monitoring interval (seconds)",
"format": "int32"
},
"timeout": {
"type": "integer",
"description": "Timeout (seconds)",
"format": "int32"
},
"target": {
"type": "string",
"description": "Monitoring target (hostname, IP address or URL)"
}
}
}
]
},
"ComputerSystem": {
"type": "object",
"properties": {
"name": { "type": "string", "description": "Name" },
"manufacturer": { "type": "string", "description": "Manufacturer" },
"model": { "type": "string", "description": "Model" },
"biosSerialNumber": { "type": "string", "description": "Bios Serial Number" },
"serialNumber": { "type": "string", "description": "Serial Number" },
"domain": { "type": "string" },
"domainRole": { "type": "string" },
"numberOfProcessors": { "type": "integer", "format": "int32" },
"totalPhysicalMemory": { "type": "integer", "format": "int64" },
"virtualMachine": { "type": "boolean" },
"chassisType": { "type": "string" }
},
"description": "Computer System (Chassis)"
},
"Device": {
"type": "object",
"properties": {
"id": { "type": "integer", "description": "Node (Device) identifier", "format": "int32" },
"parentDeviceId": {
"type": "integer",
"description": "Parent Node identifier",
"format": "int32"
},
"organizationId": {
"type": "integer",
"description": "Organization identifier",
"format": "int32"
},
"locationId": {
"type": "integer",
"description": "Location identifier",
"format": "int32"
},
"nodeClass": {
"type": "string",
"description": "Node Class",
"enum": [
"WINDOWS_SERVER",
"WINDOWS_WORKSTATION",
"LINUX_WORKSTATION",
"MAC",
"ANDROID",
"VMWARE_VM_HOST",
"VMWARE_VM_GUEST",
"HYPERV_VMM_HOST",
"HYPERV_VMM_GUEST",
"LINUX_SERVER",
"MAC_SERVER",
"CLOUD_MONITOR_TARGET",
"NMS_SWITCH",
"NMS_ROUTER",
"NMS_FIREWALL",
"NMS_PRIVATE_NETWORK_GATEWAY",
"NMS_PRINTER",
"NMS_SCANNER",
"NMS_DIAL_MANAGER",
"NMS_WAP",
"NMS_IPSLA",
"NMS_COMPUTER",
"NMS_VM_HOST",
"NMS_APPLIANCE",
"NMS_OTHER",
"NMS_SERVER",
"NMS_PHONE",
"NMS_VIRTUAL_MACHINE",
"NMS_NETWORK_MANAGEMENT_AGENT"
]
},
"nodeRoleId": {
"type": "integer",
"description": "Node Role identifier",
"format": "int32"
},
"rolePolicyId": {
"type": "integer",
"description": "Node Role policy ID based on organization Policy Mapping",
"format": "int32"
},
"policyId": {
"type": "integer",
"description": "Assigned policy ID (overrides organization policy mapping)",
"format": "int32"
},
"approvalStatus": {
"type": "string",
"description": "Approval Status",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment