Documentation Powered by ReDoc

Nexthink Chatbot Adapter (2.0.0)

Download OpenAPI specification:Download

Nexthink Integrations Team: integration.madrid@nexthink.com URL: https://doc.nexthink.com/Documentation/Nexthink/latest/APIAndIntegrations/Overview Terms of Service

The Interface provided by Nexthink to connect with third-party Chatbot applications.

Authentication

BasicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

Devices

For detailed description on each device field please refer to the Nexthink NXQL Data Model documentation.

Retrieve User Devices

Return the information of the devices used by the user.

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Example: user_1

Id of the user

query Parameters
type
string (UserType)
Enum: "distinguished_name" "name" "sid"

Id type (name of the field on NXQL)

Responses

Response samples

Content type
application/json
Example
User with two devices
User with two devices
User with one device
[
  • {
    },
  • {
    }
]

Retrieve Device Information

Return the information of the device.

Authorizations:
ApiKeyAuth
path Parameters
device_name
required
string
Example: device_1

Name of the device

Responses

Response samples

Content type
application/json
{
  • "name": "NXTV-WIN10EN-15",
  • "device_uid": "54965105b7192099cc5c17e2be830df3",
  • "platform": "windows",
  • "total_ram": 12884901888,
  • "last_ip_address": "192.168.1.126",
  • "group_name": "WORKGROUP",
  • "entity": "other",
  • "device_model": "VMware Virtual Platform",
  • "os_version_and_architecture": "Windows 10 Enterprise 1803 (64 bits)",
  • "system_drive_capacity": 33833349120,
  • "system_drive_free_space": 9047564288,
  • "number_of_days_since_last_boot": 13,
  • "last_seen": "2019-04-16T18:18:43+10:00"
}

Remote Action

For more information on Remote Actions please refer to the Nexthink User Manual documentation.

Execute a Remote Action

Execute a Remote Action on a given device. If the execution mode is asynchronous the Remote Action is queued for later execution. If the execution mode is synchronous then the body must contain the timeout.

Authorizations:
ApiKeyAuth
path Parameters
ra_id
required
string
Example: ra_id_1

The id of the Remote Action to execute

device_uid
required
string
Example: 5b49c2105f4507cd7a0f09592032fbe8

Uid of the device where it is executed

Request Body schema: application/json

If timeout is defined the Remote Action will be executed synchronously. The timeout is the maximum number of seconds to wait for completion.

timeout
number [ 10 .. 300 ]

Responses

Request samples

Content type
application/json
{
  • "timeout": 120
}

Response samples

Content type
application/json
Example
Synchronous execution
Synchronous execution
Asynchronous execution
{
  • "status": "successful",
  • "fields": {
    }
}

Get the result of a Remote Action

Get the current result of a Remote Action for a given device.

Authorizations:
ApiKeyAuth
path Parameters
ra_id
required
string
Example: ra_id_1

The id of the Remote Action to check

device_uid
required
string
Example: 5b49c2105f4507cd7a0f09592032fbe8

Uid of the device

Responses

Response samples

Content type
application/json
{
  • "status": "successful",
  • "fields": {
    }
}

Remote Actions list

Return the list of Remote Actions and associated information.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "repair_outlook_ost_problem": {
    },
  • "set_outlook_online": {
    }
}

Topic

Topic diagnosis

Return the result of the diagnosis of the given topic for the given device.

Authorizations:
ApiKeyAuth
path Parameters
topic_id
required
string
Example: app_onedrive_issues

Name of the topic

device_uid
required
string
Example: 5b49c2105f4507cd7a0f09592032fbe8

UID of the device

platform
required
string
Example: windows

Platform of the device (windows or mac_os)

query Parameters
detail_level
number (DetailLevel) [ 1 .. 3 ]
Default: 3

Detail level on the response of the diagnosis. Three possible values depending on the information returned:

  1. Only conditions matching.
  2. The conditions matching and the field values.
  3. All conditions and the actual values, including those not matching.

Responses

Response samples

Content type
application/json
Example
Diagnosis with NXQL queries and Remote Actions (diagnosis_level 1)
Diagnosis with NXQL queries and Remote Actions (diagnosis_level 1)
Diagnosis with NXQL queries (diagnosis_level 1)
Diagnosis with NXQL queries (diagnosis_level 2)
Diagnosis with NXQL queries and Remote Actions (diagnosis_level 3)
Diagnosis displaying one diagnosis error
Diagnosis displaying two remediation errors
Diagnosis displaying one error and one valid diagnosis
Remote Action configuration error
Remote Action timeout error
"[\n {\n \"diagnosis\": [\n {\n \"condition\": \"system_drive_free_space < 10000000000\",\n \"match\": true,\n \"remediation_ras\": [\n {\n \"id\": \"disk_cleanup\",\n \"endpoint\": \"/remote_action/disk_cleanup/fc158e42ac274e7ca8e08114ce07bd3b\"\n }\n ]\n },\n {\n \"condition\": \"total_drive_free_space < 20000000000\",\n \"match\": true,\n \"remediation_ras\": [\n {\n \"id\": \"disk_cleanup\",\n \"endpoint\": \"/remote_action/disk_cleanup/fc158e42ac274e7ca8e08114ce07bd3b\"\n }\n ]\n }\n ]\n },\n {\n \"diagnosis\": [\n {\n \"condition\": \"\\\"action:Get Startup Impact/HighImpactCount\\\" > 0\",\n \"match\": true\n }\n ]\n },\n {\n \"diagnosis\": [\n {\n \"condition\": \"average_network_response_time > 30000\",\n \"match\": true\n },\n {\n \"condition\": \"network_availability_level != high\",\n \"match\": true\n }\n ]\n }\n]"

Topics list

Return the list of topics.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "app_sfb_issues": {
    },
  • "device_bad_health": {
    },
  • "l1_device_checklist": {
    },
  • "pc_slow": {
    },
  • "app_outlook_issues": {
    }
}

Login

Generate a new API key

Returns a new API key to be used for authenticating the other calls.

Authorizations:
BasicAuth

Responses

Retrieve the existing API key

Returns the existing API key to be used for authenticating the other calls.

Authorizations:
BasicAuth

Responses