Reference

NAble Module

class NAbleAPI.client.NAble(region: str, key: str, logLevel: str = None, useOriginalValues: bool = True)

Bases: object

AVDefinitions(product: str, max_results: int = 20, describe: bool = False)

Lists the most recent definition versions and date released for a given AV product.

Parameters:

  • product (str) – AV product ID (can be retrieved with supportedAVs endpoint)

  • max_results (int, optional) – Max number of definitions to return. Defaults to 20.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of AV definitions with version and date released

Return type:

list

AVDefinitionsReleaseDate(product: str, version: str, describe: bool = False)

Given an antivirus product ID and a definition version, returns the date and time a definition was released.

Parameters:

  • product (str) – AV product ID (can be retrieved with supportedAVs endpoint)

  • version (str) – Version (can be retrieved with AVDefinitions endpoint)

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Product name, version, release date.

Return type:

dict

AVHistory(deviceid: int, describe: bool = False)

List status of Antivirus Update Checks on device for last 60 days.

Parameters:

  • deviceid (int) – Device ID

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Previous 60 days AV status/history. Will show status of “UNKNOWN” if AV is not enabled/running

Return type:

list

__init__(region: str, key: str, logLevel: str = None, useOriginalValues: bool = True)

Intitialize your N-Sight instance.

Parameters:

  • region (str) – Your tenant region, see wiki for complete list of regions.

  • key (str) – API key.

  • logLevel (str, optional) – Log Level. Defaults to normal level.

  • useOriginalValues (bool, optional) – Use Original values (keys and responses) in items. Names and values of some items in responses are confusing and onconsistent, so I have tried to clean them up and make them easier to use. The downside to this is that NAbles documentation cannot be used when working with this library. Anything that has been changed is documented in the ReadTheDocs for that method. Defaults to False (original names and values are kept).

Raises:

  • ValueError – _description_

  • requests.exceptions.ConnectionError – _description_

activeDirectoryUsers(siteid: int, describe: bool = False)
addClient(name: str, timezone: str = None, licenseconfig: str = None, reportconfig: str = None, officehoursemail: str = None, officehourssms: str = None, outofofficehoursemail: str = None, outofofficehourssms: str = None, describe: bool = False)

Create a new client, must at least provide a name.

Parameters:

  • name (str) – New client name.

  • timezone (str, optional) – Timezone if different than company. Available timezones can be found here: https://documentation.n-able.com/remote-management/userguide/Content/api_timezones.htm

  • licenseconfig (str, optional) – Xml license config.

  • reportconfig (str, optional) – Xml report config.

  • officehoursemail (str, optional) – Email for in hours alerts.

  • officehourssms (str, optional) – SMS for in hours alerts.

  • outofofficehoursemail (str, optional) – Email for out of hours alerts.

  • outofofficehourssms (str, optional) – SMS for out of hours alerts.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status and new client ID if successful.

Return type:

dict

addNote(checkid: int, private_note: str = None, public_note: str = None, describe: bool = False)

Add a public/private note to a check. Check will be added by the admin account/account API key was retrieved from.

Parameters:

  • checkid (int) – Check ID

  • private_note (str, optional) – Private (technical) note.

  • public_note (str, optional) – Public (customer) note.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Confirmation of note being added

Return type:

dict

addSite(clientid: int, sitename: str, router1: str = None, router2: str = None, workstationtemplate: str = 'inherit', servertemplate: str = None, describe: bool = False)

Create a new site for a client.

Parameters:

  • sitename (str) – New Site Name.

  • router1 (str, optional) – Primary router IP address.

  • router2 (str, optional) – Secondary router IP address.

  • workstationtemplate (str, optional) – Template ID of default workstation template or “inherit” to inherit the site template. Defaults to inherit. A list of templates and their IDs can be gotten using templates()

  • servertemplate (str, optional) – Template ID of default server template or “inherit” to inherit the site template. Defaults to inherit. A list of templates and their IDs can be gotten using templates()

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status and site ID is successful.

Return type:

dict

agentlessAssets(siteid: int, describe: bool = False)

Get all agentless and mini-agent asset devices for site (including top level asset information)

Parameters:

  • siteid (int) – Site ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of agentless devices.

Return type:

list

approvePatches(deviceid: int, patchids: list, describe: bool = False)

Approve patch(es) for a specific device. Approving a patch that has already been approved does not cause an issue.

Patches set to Approve will install at the next scheduled installation time as set by the devices Patch Management policy.

Patches that are approved using this will show policy ID 66 instead of 2.

Parameters:

  • deviceid (int) – Device ID

  • patchids (str,list) – Patch ID(s). Use a list or comma separated string to send multiple at once

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Nothing of value is returned. May remove this

Return type:

dict

assetDetails(deviceid: int, describe: bool = False)

Get device asset details by device ID.

Includes some software and hardware asset details. These details are NOT the same as the ones provided from the dedicated endpoints!

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Asset details including asset ID, asset hardware, and asset software.

Return type:

dict

assetHardware(assetid: int, describe: bool = False)

Get all hardware for an asset.

Included in each hardware item will be a hardware ID and hardware type. Hardware types listed below

Hardware Types:

  • 1: Network Adapter

  • 2: BIOS

  • 3: Sound device

  • 4: Motherboard

  • 5: Keyboard

  • 6: Pointing device

  • 7: Monitor

  • 8: Video Controller

  • 9: Disk Drive

  • 10: Logical Disk

  • 11: Physical Memory

  • 12: Cache Memory

  • 13: Processor

  • 14: Tape Drive

  • 15: Optical Drive

  • 16: Floppy Disk Drive (yes, really)

Note: Manufacturer may show as None for some components on Apple devices.

Parameters:

  • assetid (int) – Asset ID. Can be gotten in using workstations() under ‘assetid’ or by using assetDetails() with a device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of asset hardware.

Return type:

list

assetLicensedSoftware(assetid: int, describe: bool = False)

_summary_

Parameters:

  • assetid (int) – Asset ID. Can be gotten in using workstations() under ‘assetid’ or by using assetDetails() with a device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

_description_

Return type:

_type_

assetSoftware(assetid: int, describe: bool = False)

Get all software for an asset.

Note:

  • Version and install date may not work on Apple devices.

Parameters:

  • assetid (int) – Asset ID. Can be gotten in using workstations() under ‘assetid’ or by using assetDetails() with a device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of asset software.

Return type:

list

backupHistory(deviceid: int, describe: bool = False)

Lists status of backup (based on check) for the last 60 (or 90) days. Requires backup check to be present on device. Works with MoB/Cove. May not work with MacOS devices.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Previous 60 days backup history. Will show status of “UNKNOWN” if backup check is not present.

Return type:

list

backupSelectionSize(cliendid: int, siteid: int, deviceid: int, year: int, month: int, describe: bool = False)

Returns the Backup & Recovery - previously known as Managed Online Backup - (MOB) selection size for the specified device for the entered month and year combination. Please be aware that the backup values stated in this API call are in Bytes.

Parameters:

  • cliendid (int) – Client ID.

  • siteid (int) – Site ID.

  • deviceid (int) – Device ID.

  • year (int) – Year.

  • month (int) – Month (00-12).

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

_description_

Return type:

_type_

backupSessions(deviceid: int, describe: bool = False)

ists all Backup & Recovery - previously known as Managed Online Backup - (MOB) sessions for a device.

Note: Backups are recorded in batches after the whole batch finishes; once recorded the information about all backup sessions is available for the lifespan of the device, whilst Backup & Recovery remains enabled.

Please be aware that the backup values stated in this API call are in Bytes.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

_description_

Return type:

_type_

checkConfig(checkid: int, describe: bool = False)

Lists configuration for the specified check.

Parameters:

  • checkid (int) – Check ID

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Single check configuration

Return type:

dict

checks(deviceid: int, describe: bool = False)

Lists all checks for device. Gets slightly more infromation than the device details.

Parameters:

  • deviceid (int) – Device ID

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of checks for device

Return type:

list

clearCheck(checkid: int, private_note: str = None, public_note: str = None, clear_type: str = None, clear_until: str = None, describe: bool = False)

Clear a check status. After a check has failed, mark it as ‘cleared’, thereby acknowledging the cause of the failure.The check will be shown using an amber tick. A note describes the reason for the failure and the action taken by the engineer.

This API call is only supported where Check Clearing is enabled on the account for this check frequency type, i.e. 24x7 and/or Daily Safety Check.

Learn more about enabling check clearing here: https://documentation.n-able.com/remote-management/userguide/Content/configure_check_clearing.htm

Notes

Where the option to Prompt for notes when clearing failed checks is enabled in Settings > General Settings> Notes, both the public

note (customer facing) and the private note (for engineers) must be non-empty.

Any Check clearing action adds an entry in the User Audit Report.

Parameters:

  • checkid (int) – Check ID.

  • private_note (str, optional) – Private (technical) note.

  • public_note (str, optional) – Public (customer) note.

  • clear_type (str, optional) – Action taken on clearing check untilpasses, untilnextrun, or untildatetime*.

  • clear_until (str, optional) – *If untildatetime is selected as the clear_type then this date/time value is required to determine how long a check will be cleared until (ISO-8601).

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

_description_

Return type:

_type_

clientDevices(clientid: int, devicetype: str, describe: bool = False, includeDetails: bool = False, experimentalChecks: bool = False)

Get all devices of type ‘server/workstation’ for a client. Optionally, get their details.

Parameters:

  • clientid (int) – Client ID.

  • devicetype (str) – Device type. [server, workstation, mobile_device].

  • includeDetails (bool, optional) – Include full device details for all devices. Defaults to False.

  • experimentalChecks (bool, optional) – Whether to try experimental checks. includeDetails must be True. More information can be found in the documentation. Defaults to False.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

All devices for a client.

Return type:

list

clientLicenseCount(clientid: int, describe: bool = False)

Get client software license counts.

Parameters:

  • clientid (int) – Client ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

License counts for software?

Return type:

list

clients(devicetype: str = None, name: str = None, describe: bool = False)

Get all clients. Optionally, filter by ‘devicetype’ and/or name.

Device types - workstation - server - mobile_device

Parameters:

  • devicetype (str, optional) – Filter by device type.

  • name (str, optional) – Filter/search for client by name. Helpful if trying to get a specific ID

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of clients

Return type:

list

deviceDetails(deviceid: int, experimentalChecks: bool = False, describe: bool = False)

Get all monitoring information for the device (server or workstation). This information can also be gotten using the clientDevices() method.

Parameters:

  • deviceid (int) – Device ID.

  • experimentalChecks (bool, optional) – Whether to try experimental checks. More information can be found in the documentation. Defaults to False.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Full device details

Return type:

dict

doNothingPatches(deviceid: int, patchids: str, describe: bool = False)

Set patch(es) to “Do Nothing” for a specific device.

Patches set to “Do Nothing” will be installed according to the applied Patch Management policy.

Patches that are changed using this will show policy ID 68 instead of 4.

Parameters:

  • deviceid (int) – Device ID

  • patchids (str,list) – Patch ID(s). Use a list or comma separated string to send more than 1 at once.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Nothing of value is returned.

Return type:

dict

driveSpaceHistory(deviceid: int, interval: str = 'DAY', since: str = None, describe: bool = False)

Returns the daily , weekly or monthly disk space usage information for a device. Only available for devices which have active FREE_DRIVE_SPACE check(s).

Parameters:

  • deviceid (int) – Device ID

  • interval (str) – Inverval length. [DAY, WEEK, MONTH]. Defaults to DAY

  • since (str, optional) – Set a start date (ISO-8601, format depends on interval).

  • [year]-[month]-[day] (- DAY =)

  • number] (- WEEK = [year]W[week)

  • [year]-[month] (- MONTH =)

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Dict with drive letter and check ID, includes LIST (history) with historical information

Return type:

dict

edrPresent(deviceid: int)

Check if EDR is present on a device. by looking first at software, then at device checks.

WARNING: This is experimental and may not always find EDR (or lack of EDR) Use at your own risk

Note:

  • Install date and version may not work on Apple devices.

  • May not work at all on apple devices

Parameters:

deviceid (int) – Device ID.

Returns:

Whether EDR is installed, if EDR is installed a version and install date will also be provided

Return type:

dict

exchangeStorageHistory(deviceid: int, interval: str, since: str = None, describe: bool = False)

Returns the daily (interval=DAY), weekly (interval=WEEK) or monthly (interval=MONTH) Exchange Store Size information for a device. Only available for devices where the (Windows server only) Exchange Store Size Check is configured.

Parameters:

  • deviceid (int) – Device ID

  • interval (str) – Inverval length. [DAY,WEEK,MONTH]

  • since (str, optional) – Set a start date (ISO-8601, format depends on interval).

  • [year]-[month]-[day] (- DAY =)

  • number] (- WEEK = [year]W[week)

  • [year]-[month] (- MONTH =)

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

_description_

Return type:

_type_

failingChecks(clientid: int = None, check_type: str = None, describe: bool = False)

List all failing checks for all clients

Parameters:

  • clientid (int, optional) – Client ID.

  • check_type (str, optional) – Check type [checks,tasks,random]. Random will return all failing checks

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

failing checks by client

Return type:

list

formattedCheckOutput(checkid: int, describe: bool = False)

Returns formatted Dashboard More Information firstline result of check (error or otherwise)

Parameters:

  • checkid (int) – Check ID

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

First line of check result (usually a string)

Return type:

any

generalSettings(describe: bool = False)

Lists general (basic) settings for account including language, whether checks can be cleared, and the timezone.

Parameters:

describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

General settings.

Return type:

dict

ignorePatches(deviceid: int, patchids: str, describe: bool = False)

Ignore patch(es) for a specific device.

Patches set to “Ignore” will be explicitely blocked (ignored) and will not show as “missing” in reports or dashboard.

Patches that are changed using this will show policy ID of 65.

Parameters:

  • deviceid (int) – Device ID

  • patchids (str,list) – Patch ID(s). Use a list or comma separated string to send more than 1 at once.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Nothing of value is returned.

Return type:

dict

licenseGroupItems(license_group_id: int, describe: bool = False)

Get software in a software license group.

Parameters:

  • license_group_id (int) – License Group ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

License Software group information (very limited)

Return type:

dict

licenseGroups(describe: bool = False)

Get all software license groups for account/tenant.

Parameters:

describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of license groups and IDs

Return type:

list

listPatches(deviceid: int, describe: bool = False)

Get all patch information for a device using the device ID.

Included in the response is the patch status, and the patch policy currently applied. Below is a list of Polices, Status, and their IDs.

Policies and IDs

  • Ignore: 1 or 65 if set by user (via API or dashbaord). If you find a patch ignored by a policy, please send me the ID!

  • Approve: 2 or 66 if set by user (via API or dashbaord)

  • Do Nothing: 4 or 68 if set by user (via API or dashbaord)

Statuses and IDs

  • Missing: 1

  • Pending: 2

  • Queued: 4

  • Installed: 8

  • Failed: 16

  • Ignored: 23

  • Reboot Required: 64

If you find additional statuses or IDs, please let me know!

Parameters:

  • deviceid (int) – Device ID

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of patches (both available and installed).

Return type:

list

mavQuarantine(deviceid: int, av: str = 'bitdefender', describe: bool = False)

Get quarantined threats for a device.

Parameters:

  • deviceid (int) – Device ID.

  • av (str, optional) – Specify which AV should be checked [vipre, bitdefender]. Defaults to bitdefender.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of quarantined items or None if nothing is quarantined

Return type:

list,none

mavQuarantineList(deviceid: int, items: str = None, av: str = 'bitdefender', describe: bool = False)
mavQuarantineRelease(deviceid: int, guids: str, describe: bool = False)

Release threat(s) from Managed Antivirus quarantine.

Parameters:

  • deviceid (int) – Device ID.

  • guids (str) – GUID(s) of quarantined threats. Use a list or comma separated string to send multiple at once.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status message (if any). If no message is returned, assume successful.

Return type:

str

mavQuarantineRemove(deviceid: int, guids: str, describe: bool = False)

Remove threat(s) from Managed Antivirus quarantine.

Parameters:

  • deviceid (int) – Device ID.

  • guids (str) – GUID(s) of quarantined threats. Use a list or comma separated string to send multiple at once.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status message (if any). If no message is returned, assume successful.

Return type:

str

mavScanCancel(deviceid: int, describe: bool = False)

Cancel scan on a device.

Scan will not be cancelled immediately.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status message (if any). If no message is returned, assume successful. If no scan is running, ‘An error has occurred’ may be returned.

Return type:

str

mavScanList(deviceid: int, av: str = 'bitdefender', describe: bool = False)

Get a list of scans for a device. Scans currently running may not be included.

Parameters:

  • deviceid (int) – Device ID.

  • av (str, optional) – Specify which AV should be checked [vipre, bitdefender]. Defaults to bitdefender.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of scans.

Return type:

list

mavScanPause(deviceid: int, describe: bool = False)

Pause scan on a device.

Scan will not be paused immediately.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status message (if any). If no message is returned, assume successful. If no scan is running, ‘Unsupported action type’ may be returned.

Return type:

str

mavScanResume(deviceid: int, describe: bool = False)

Resume/unpause scan on a device.

Scan will not be resumed immediately.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False. If no scan is running, ‘Unsupported action type’ may be returned.

Returns:

Status message (if any). If no message is returned, assume successful.

Return type:

str

mavScanStart(deviceid: int, describe: bool = False)

Start quick scan on a device.

Scan will not start immediately. If a scan is already running, an error will be returned.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status message (if any). If no message is returned, assume successful. If a scan is already running, ‘An error has occurred’ may be returned.

Return type:

str

mavScans(deviceid: int, details: bool = True, av: str = 'bitdefender', describe: bool = False)

Get a list of scans for a device, should include active scans (but sometimes it doesn’t)

This will return slightly different information than mavScanList() although I don’t know why they aren’t the same thing.

Parameters:

  • deviceid (int) – Device ID.

  • details (bool, optional) – Wheter to provide extra details, including threats and errors. Defaults to True (yes).

  • av (str, optional) – Specify which AV should be checked [vipre, bitdefender]. Defaults to bitdefender.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of scans.

Return type:

list

mavThreats(deviceid: int, av: str = 'bitdefender', describe: bool = False)

Get the most recent occurence of each threat found on a device.

These threats may or may not be in quarantine.

Parameters:

  • deviceid (int) – Device ID.

  • av (str, optional) – Specify which AV should be checked [vipre, bitdefender]. Defaults to bitdefender.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of threats.

Return type:

list

mavUpdate(deviceid: int, describe: bool = False)

Update the bitdefender definitions on a device (does not work with Vipre)

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Status message (if any). If update is already pending ‘There is already a MAV definition update pending’ will be returned here. If nothing is returned, assume successful.

Return type:

str

outages(deviceid: int, describe: bool = False)

Returns list of outages which are either still open, or which were closed in last 61 days.

Parameters:

  • deviceid (int) – Device ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of outages

Return type:

list

performanceHistory(deviceid: int, interval: int = 15, since: str = None, describe: bool = False)

Obtains the data relating to all the Performance and Bandwidth Monitoring Checks running on the specified device.

Data is available for 24 hours at 15 minute intervals and for 8 days at hourly intervals. If data is needed for longer then it will need to be stored; for efficiency use the since parameter to only obtain new data.

Note: The Windows Agent supports the Performance Monitoring Check for workstations.

Parameters:

  • deviceid (int) – Device ID.

  • interval (int, optional) – Interval duration (in minutes). Valid options[15, 60]. 15 will get previous 24 hours, 60 will get up to 8 days. Defaults to 15.

  • since (str, optional) – Set a start date (ISO-8601). Defaults to None.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

_description_

Return type:

_type_

reprocessPatches(deviceid: int, patchids: str, describe: bool = False)

Reprocess failed patch(es) for a specific device.

If a patch has reviously failed to install, use this to retry the install. Patches will attempt to install at the next scheduled installation time as set by the devices Patch Management policy.

Failed Patches will show status ID 16. The policy ID will not change if a patch has failed to install. Patches that are changed using this will show their original polcy, and status ID 2 (pending)

If you try to reprocess a patch that has not failed to install (installed, pending, ignored) you will get a response stating “Patches already applied: {PATCH IDS}”.

Parameters:

  • deviceid (int) – Device ID

  • patchids (str,list) – Patch ID(s). Use a list or comma separated string to send more than 1 at once.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Additional information (if any) about selected patches.

Return type:

str

retryPatches(deviceid: int, patchids: str, describe: bool = False)

Retry failed patch(es) for a specific device. Appears to do exactply the same thing as reprocess, even provides the same messages.

If a patch has reviously failed to install, use this to retry the install. Patches will try to install at the next scheduled installation time as set by the devices Patch Management policy.

Failed Patches will show status ID 16. The policy ID will not change if a patch has failed to install. Patches that are changed using this will show their original polcy, and status ID 2 (pending)

If you try to reprocess a patch that has not failed to install (installed, pending, ignored) you will get a response stating “Patches already applied: {PATCH IDS}”.

Parameters:

  • deviceid (int) – Device ID

  • patchids (str,list) – Patch ID(s). Use a list or comma separated string to send more than 1 at once.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Additional information (if any) about selected patches.

Return type:

str

runTask(checkid: int, describe: bool = False)
servers(siteid: int, describe: bool = False)

Get all servers for site (including top level asset information if available).

Parameters:

  • siteid (int) – Site ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of servers.

Return type:

list

siteInstallPackage(endcustomerid: int, siteid: int, os: str, type: str, beta: bool = False, mode: str = None, proxyenabled: bool = None, proxyhost: str = None, proxyport: int = None, proxyusername: str = None, proxypassword: str = None, describe: bool = False)

Creates a Site Installation Package based on the specified installer type. Where successful a package is created and downloaded.

Notes

By default this package is based on the latest General Availability Agent unless the beta=true parameter is used. In this case the Site Installation Package contains the current Release Candidate Agent.

Support for Mac and Linux Site Installation Packages was introduced in Dashboard v2020.05.21. To maintain previously configured API calls, the Site Installation Package defaults to Windows where an os parameter is not provided.

Parameters:

  • endcustomerid (int) – Client ID.

  • siteid (int) – Site ID.

  • os (str) – OS that package should be for [mac,windows,linux]

  • type (str) – Type of installer to download [remote_worker,group_policy]. Note: group_policy only works with Windows

  • beta (bool, optional) – Download the beta (RC) agent. Defaults to False.

  • mode (str, optional) – Mode [authenticate, downloadgp, downloadrwbuild]. Defaults to None.

  • proxyenabled (bool, optional) – (DEPRECATED) Use Proxy. Defaults to None.

  • proxyhost (str, optional) – (DEPRECATED) Proxy Host. Defaults to None.

  • proxyport (int, optional) – (DEPRECATED) Proxy Port. Defaults to None.

  • proxyusername (str, optional) – (DEPRECATED) Proxy username. Defaults to None.

  • proxypassword (str, optional) – (DEPRECATED)Proxy password. Defaults to None.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

raw bytes object.

Return type:

bytes

sites(clientid: int, describe: bool = False)

Get all sites for a client.

Parameters:

  • clientid (int) – Client ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of client sites

Return type:

list

supportedAVs(describe: bool = False)

Lists display name and identifier for all supported antivirus products.

Parameters:

describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of supported AVs with ID

Return type:

list

templates(devicetype: str = None, describe: bool = False)

List all monitoring templates. Optionally, filter by device type.

Parameters:

  • devicetype (str, optional) – Device type [server, workstation].

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of templates with template IDs. No details are provided.

Return type:

list

wallchartSettings(describe: bool = False)

Lists general Wall Chart settings for account including what should and shouldn’t be shown.

Parameters:

describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

Wallchart settings.

Return type:

dict

workstations(siteid: int, describe: bool = None)

Get all workstations for site (including top level asset information if available).

This will NOT provide check information details.

N-Able documentation: https://documentation.n-able.com/remote-management/userguide/Content/listing_workstations_.htm

Parameters:

  • siteid (int) – Site ID.

  • describe (bool, optional) – Returns a discription of the service. Defaults to False.

Returns:

List of workstations.

Return type:

list