Skip to main content
Tools Reference

N-able N-central Tools

Written By Christopher Scaminaci

Last updated 7 days ago

N-able N-central Tools

ncentral_ · 104 tools · Free 70 · Pro 34 Per-user JWT exchanged for a short-lived access token; per-tenant base URL; offset pagination (pageSize 1-1000); Search/Get-All/Reports/Overviews are client-side aggregations.

All connector tools · N-able N-central setup guide

N-able N-central tool groups

Server Info

ToolPlanAccessSummary
ncentral_get_healthFreeRead-onlyGet the N-central API health status.
ncentral_get_server_infoFreeRead-onlyGet N-central server identification and version metadata.
ncentral_get_server_info_extraFreeRead-onlyGet extended server metadata (preview endpoint).
ncentral_get_server_info_extra_authenticatedFreeRead-onlyGet authenticated server metadata (preview endpoint).

[N-able N-central] Get the N-central API health status. Returns service liveness and component-level health indicators. Use this in dashboards to confirm the upstream is reachable before deeper calls.

[N-able N-central] Get N-central server identification and version metadata. Returns server name, version, build, locale, and other top-level deployment facts. Use this for credential validation and version-gating decisions.

[N-able N-central] Get extended server metadata (preview endpoint). Returns build channel, deployment region hints, and capability flags beyond the base server-info shape. Use ncentral_get_server_info_extra_authenticated when you need fields that require authenticated context. PREVIEW endpoint — N-able may evolve the response shape.

[N-able N-central] Get authenticated server metadata (preview endpoint). POST-as-read carrying caller context in the body; returns capability flags and configuration hints scoped to the authenticated user. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional JSON body (defaults to empty object ). Use to pass caller hints (locale/version) when N-central documents them.

Devices

ToolPlanAccessSummary
ncentral_get_appliance_task_infoFreeRead-onlyGet the execution detail for an appliance task by its taskId — used to inspect direct-support task results, AMP runs, or other appliance-side jobs.
ncentral_get_device_asset_infoFreeRead-onlyGet hardware and OS asset details for a device (manufacturer, model, serial, OS version, CPU, RAM, disks).
ncentral_get_device_by_idFreeRead-onlyGet a single device by its deviceId.
ncentral_get_device_lifecycle_infoFreeRead-onlyGet lifecycle/warranty metadata for a device (purchase date, warranty expiration, vendor contract, retirement date, asset tag, cost).
ncentral_get_device_service_monitor_statusFreeRead-onlyGet a device's service-monitor health status (NORMAL/WARNING/FAILED).
ncentral_list_devicesFreeRead-onlyList monitored devices.
ncentral_list_devices_by_org_unit_idFreeRead-onlyList devices belonging to a specific organization unit (SO/Customer/Site).
ncentral_patch_asset_lifecycle_infoProWritePartial update of a device's lifecycle-info object.
ncentral_replace_asset_lifecycle_infoProDestructiveReplace the entire lifecycle-info object for a device (PUT semantics).

[N-able N-central] Get the execution detail for an appliance task by its taskId — used to inspect direct-support task results, AMP runs, or other appliance-side jobs. Use ncentral_get_scheduled_task / ncentral_get_scheduled_task_status for scheduled-task IDs instead. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
taskIdstringyesThe appliance task ID.

[N-able N-central] Get hardware and OS asset details for a device (manufacturer, model, serial, OS version, CPU, RAM, disks). Companion to ncentral_get_device_lifecycle_info for full asset+lifecycle context.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device ID.

[N-able N-central] Get a single device by its deviceId. Returns the full device record (longName, deviceClass, online state, orgUnitId, OS, IP, lastApplianceCheckinTime, etc.). Use ncentral_list_devices first to find IDs.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device ID.

[N-able N-central] Get lifecycle/warranty metadata for a device (purchase date, warranty expiration, vendor contract, retirement date, asset tag, cost). To update fields use ncentral_patch_asset_lifecycle_info (preferred) or ncentral_replace_asset_lifecycle_info (full replace).

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device ID.

[N-able N-central] Get a device's service-monitor health status (NORMAL/WARNING/FAILED). Useful for at-a-glance health dashboards or to surface which monitors are firing on a host. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device ID.

[N-able N-central] List monitored devices. Returns paginated list of devices with deviceId, longName, deviceClass, orgUnitId, customer/site IDs, and lastApplianceCheckinTime. Use ncentral_get_device_by_id for full device detail. Use filterId from ncentral_list_device_filters to scope. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
filterIdstringnonullOptional filter ID from ncentral_list_device_filters to scope results. Omit for all visible devices.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by. Omit for no sort.
sortOrderstringnonullSort direction: ASC|DESC. Omit for ASC.

[N-able N-central] List devices belonging to a specific organization unit (SO/Customer/Site). Same response shape as ncentral_list_devices, but scoped to the orgUnitId. Use ncentral_list_organization_units to find valid orgUnitIds. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
filterIdstringnonullOptional filter ID from ncentral_list_device_filters to scope results.
orgUnitIdstringyesOrganization unit ID (SO / Customer / Site).
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by. Omit for no sort.
sortOrderstringnonullSort direction: ASC|DESC. Omit for ASC.

[N-able N-central] Partial update of a device's lifecycle-info object. Only fields present in the body are modified; unset fields are preserved (PATCH semantics). Preferred over ncentral_replace_asset_lifecycle_info for everyday edits because it cannot accidentally clear fields.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device ID.
fieldsJsonstringyesJSON body — only the lifecycle-info fields to modify.

[N-able N-central] Replace the entire lifecycle-info object for a device (PUT semantics). Side effect: replaces the entire field set; unspecified fields are silently cleared. Prefer ncentral_patch_asset_lifecycle_info for partial updates. Body shape mirrors the response from ncentral_get_device_lifecycle_info.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device ID.
fieldsJsonstringyesJSON body — full lifecycle-info object. Any field omitted will be cleared upstream.

Organization Units

ToolPlanAccessSummary
ncentral_create_customerProWriteCreate a new customer under a specific service organization.
ncentral_create_service_organizationProWriteCreate a new service organization.
ncentral_create_siteProWriteCreate a new site under a specific customer.
ncentral_get_customerFreeRead-onlyGet a single customer by ID.
ncentral_get_organization_unitFreeRead-onlyGet a single organization unit (SO/Customer/Site) by ID — useful when you only have a unit ID and don't yet know its tier.
ncentral_get_service_organizationFreeRead-onlyGet a single service organization by ID.
ncentral_get_siteFreeRead-onlyGet a single site by ID.
ncentral_list_customersFreeRead-onlyList all customers across every service organization the caller can see.
ncentral_list_customers_under_soFreeRead-onlyList customers belonging to a specific service organization.
ncentral_list_organization_unit_childrenFreeRead-onlyList the direct children of an organization unit (e.g. customers under an SO, sites under a customer).
ncentral_list_organization_unitsFreeRead-onlyList ALL organization units across all tiers (Service Organizations + Customers + Sites) as a flat list.
ncentral_list_service_organizationsFreeRead-onlyList service organizations (SOs) — the top of the orgUnit tree.
ncentral_list_sitesFreeRead-onlyList all sites across every customer the caller can see.
ncentral_list_sites_under_customerFreeRead-onlyList sites belonging to a specific customer.

[N-able N-central] Create a new customer under a specific service organization. Body shape varies by N-central version — consult the OpenAPI spec for required fields. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body for the new customer — see N-central API docs for required fields.
soIdstringyesThe parent service organization ID.

[N-able N-central] Create a new service organization. Body shape varies by N-central version — consult the OpenAPI spec for required fields (typically name + identifying fields). PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body for the new SO — see N-central API docs for required fields.

[N-able N-central] Create a new site under a specific customer. Body shape varies by N-central version — consult the OpenAPI spec for required fields. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
customerIdstringyesThe parent customer ID.
fieldsJsonstringyesJSON body for the new site — see N-central API docs for required fields.

[N-able N-central] Get a single customer by ID. Returns customer name, address, contact info, parent SO, and child site counts. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
customerIdstringyesThe customer ID.

[N-able N-central] Get a single organization unit (SO/Customer/Site) by ID — useful when you only have a unit ID and don't yet know its tier. Returns the unit's identity, parent linkage, and tier. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesThe organization unit ID.

[N-able N-central] Get a single service organization by ID. Returns name, description, contact info, and child counts. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
soIdstringyesThe service organization ID.

[N-able N-central] Get a single site by ID. Returns site name, address, parent customer, parent SO, and device counts. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
siteIdstringyesThe site ID.

[N-able N-central] List all customers across every service organization the caller can see. Use ncentral_list_customers_under_so to scope to a single SO, or ncentral_search_customers_by_name to substring-search by name.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] List customers belonging to a specific service organization. Each customer in turn contains one or more sites. Use ncentral_list_sites_under_customer to drill in. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
soIdstringyesThe service organization ID.
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] List the direct children of an organization unit (e.g. customers under an SO, sites under a customer). Companion to ncentral_get_organization_unit for tree traversal. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesThe parent organization unit ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] List ALL organization units across all tiers (Service Organizations + Customers + Sites) as a flat list. Each item carries its level identifier. Use ncentral_list_service_organizations / ncentral_list_customers / ncentral_list_sites when you need a single tier.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] List service organizations (SOs) — the top of the orgUnit tree. Each SO contains one or more customers. Use ncentral_list_customers_under_so to drill in. Use ncentral_get_all_service_organizations for an exhaustive walk.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by. Omit for no sort.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] List all sites across every customer the caller can see. Use ncentral_list_sites_under_customer to scope to a single customer, or ncentral_search_sites_by_name to substring-search by name.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] List sites belonging to a specific customer. Sites are the leaf orgUnit type — devices register against a site (or a customer directly). PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
customerIdstringyesThe customer ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

Device Filters

ToolPlanAccessSummary
ncentral_list_device_filtersFreeRead-onlyList device filters available to the caller.

[N-able N-central] List device filters available to the caller. A filter ID can be passed to ncentral_list_devices / ncentral_list_devices_by_org_unit_id (and walk-pagination variants) to scope results without re-implementing N-central's filter DSL. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.
viewScopestringnonullFilter visibility scope: ALL or OWN_AND_USED. Omit for default scope.

Custom Properties

ToolPlanAccessSummary
ncentral_get_device_custom_propertyFreeRead-onlyGet the current value of a single custom property on a device.
ncentral_get_device_custom_property_default_at_org_unitFreeRead-onlyGet the default value of a DEVICE custom property as defined at a specific orgUnit.
ncentral_get_org_unit_custom_propertyFreeRead-onlyGet the current value of a single custom property on an organization unit.
ncentral_get_org_unit_custom_property_defaultFreeRead-onlyGet the default value for a single org-unit-level custom property.
ncentral_list_device_custom_propertiesFreeRead-onlyList all custom properties (and their current values) for a single device.
ncentral_list_org_unit_custom_propertiesFreeRead-onlyList custom properties defined on an organization unit (SO/Customer/Site).
ncentral_update_device_custom_propertyProDestructiveUpdate (PUT) the value of a single custom property on a device.
ncentral_update_org_unit_custom_property_defaultsProDestructiveUpdate (PUT) the default-value set for org-unit custom properties at a given orgUnit.
ncentral_update_org_unit_custom_property_valueProDestructiveUpdate (PUT) the value of a single custom property on an organization unit.

[N-able N-central] Get the current value of a single custom property on a device. Use ncentral_list_device_custom_properties to find property IDs. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
deviceIdstringyesDevice ID.
propertyIdstringyesCustom-property ID.

[N-able N-central] Get the default value of a DEVICE custom property as defined at a specific orgUnit. Use this to introspect inherited defaults before changing a device's own value via ncentral_update_device_custom_property. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID where the default is defined.
propertyIdstringyesDevice custom-property ID.

[N-able N-central] Get the current value of a single custom property on an organization unit. Use ncentral_list_org_unit_custom_properties to find property IDs. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID.
propertyIdstringyesCustom-property ID.

[N-able N-central] Get the default value for a single org-unit-level custom property. Defaults are inherited by child orgUnits unless explicitly overridden. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID where the default is defined.
propertyIdstringyesCustom-property ID.

[N-able N-central] List all custom properties (and their current values) for a single device. Use ncentral_get_device_custom_property for a specific property. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
deviceIdstringyesDevice ID.

[N-able N-central] List custom properties defined on an organization unit (SO/Customer/Site). Each property carries id, name, value, dataType, and propagation behaviour. Use ncentral_get_org_unit_custom_property for a specific property. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID (SO/Customer/Site).
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] Update (PUT) the value of a single custom property on a device. Side effect: replaces the entire property value object. Use ncentral_get_device_custom_property to see the current shape before editing. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
deviceIdstringyesDevice ID.
fieldsJsonstringyesJSON body — the new property value envelope.
propertyIdstringyesCustom-property ID.

[N-able N-central] Update (PUT) the default-value set for org-unit custom properties at a given orgUnit. Side effect: when the body sets the propagation flag, defaults cascade to descendants — applying values to every child SO/Customer/Site below the unit. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body — defaults object with optional propagation flag.
orgUnitIdstringyesOrganization unit ID at which to set the defaults.

[N-able N-central] Update (PUT) the value of a single custom property on an organization unit. Side effect: replaces the entire property value object. Use ncentral_get_org_unit_custom_property to see the current shape before editing. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body — the new property value envelope.
orgUnitIdstringyesOrganization unit ID.
propertyIdstringyesCustom-property ID.

Scheduled Tasks

ToolPlanAccessSummary
ncentral_create_direct_support_taskProDestructiveDESTRUCTIVE: this executes immediately against the target device — it is run now, NOT scheduled for later — and can change endpoint state (it runs an Automation Policy / Script / MacScript on the…
ncentral_get_scheduled_taskFreeRead-onlyGet a scheduled-task definition by taskId.
ncentral_get_scheduled_task_statusFreeRead-onlyGet the current aggregate status of a scheduled task (queued / running / complete / failed).
ncentral_list_scheduled_task_status_detailsFreeRead-onlyList per-device execution detail for a scheduled task — useful when the task targeted multiple devices and you need a per-device pass/fail breakdown.

[N-able N-central] DESTRUCTIVE: this executes immediately against the target device — it is run now, NOT scheduled for later — and can change endpoint state (it runs an Automation Policy / Script / MacScript on the endpoint). Create a direct-support task on a single device. Body must specify taskType (AutomationPolicy | Script | MacScript), the target deviceId, and the appropriate identifier (automationPolicyId / scriptId / macScriptId). Use the per-taskType wrappers (ncentral_run_automation_policy_on_device, ncentral_run_script_on_device, ncentral_run_mac_script_on_device) for a narrower parameter surface.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body — see N-central docs for taskType-specific fields. Required keys typically include taskType, deviceId, and the action identifier.

[N-able N-central] Get a scheduled-task definition by taskId. Returns the task type, target device(s), and configuration. Pair with ncentral_get_scheduled_task_status for current execution state.

ParamTypeRequiredDefaultDescription
taskIdstringyesThe scheduled task ID.

[N-able N-central] Get the current aggregate status of a scheduled task (queued / running / complete / failed). Use ncentral_list_scheduled_task_status_details for per-device breakdown when the task targets multiple devices.

ParamTypeRequiredDefaultDescription
taskIdstringyesThe scheduled task ID.
ParamTypeRequiredDefaultDescription
taskIdstringyesThe scheduled task ID.

Maintenance Windows

ToolPlanAccessSummary
ncentral_add_maintenance_windows_bulkProWriteAdd the same set of maintenance windows to a list of devices in one call.
ncentral_delete_maintenance_windows_bulkProDestructiveWARNING: Permanently remove one or more maintenance windows by schedule ID.
ncentral_get_maintenance_windows_for_deviceFreeRead-onlyList the maintenance windows currently configured on a single device.

[N-able N-central] Add the same set of maintenance windows to a list of devices in one call. N-central quirk: the property is camel-case `deviceIDs` (not deviceIds). Body shape: {"deviceIDs": [...], "windows": [...]}. Use ncentral_get_maintenance_windows_for_device to confirm after creation. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body — {"deviceIDs": ["123", "456"], "windows": [...]}. Note camel-case deviceIDs (with capital ID).

[N-able N-central] WARNING: Permanently remove one or more maintenance windows by schedule ID. N-central quirk: this is a DELETE with a JSON BODY. Body shape: {"scheduleIds": [1, 2, 3]}. Use ncentral_get_maintenance_windows_for_device first to confirm the schedule IDs you intend to delete. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body — {"scheduleIds": [1, 2, 3]} listing maintenance-window IDs to remove.

[N-able N-central] List the maintenance windows currently configured on a single device. Returns each window's schedule ID, recurrence, and time bounds — values you can pass to ncentral_delete_maintenance_windows_bulk. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
deviceIdstringyesDevice ID.

Users

ToolPlanAccessSummary
ncentral_list_users_for_org_unitFreeRead-onlyList users with access to a specific organization unit (SO/Customer/Site).

[N-able N-central] List users with access to a specific organization unit (SO/Customer/Site). Returns user ID, login, email, name, and role assignment. Use ncentral_search_users_by_email to substring-search across an orgUnit. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

User Roles

ToolPlanAccessSummary
ncentral_add_user_roleProWriteCreate a new user role at a specific organization unit.
ncentral_get_user_roleFreeRead-onlyGet a single user role by ID — returns the role's name, permission set, and assigned users count.
ncentral_list_user_rolesFreeRead-onlyList user roles defined at an organization unit (SO/Customer/Site).

[N-able N-central] Create a new user role at a specific organization unit. Body shape varies — consult the OpenAPI spec for required fields (typically name + permission list). PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body for the new user role.
orgUnitIdstringyesOrganization unit ID where the role is defined.

[N-able N-central] Get a single user role by ID — returns the role's name, permission set, and assigned users count. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID that owns the role.
userRoleIdstringyesUser role ID.

[N-able N-central] List user roles defined at an organization unit (SO/Customer/Site). Each role groups a set of permissions. Use ncentral_get_user_role for the full role record including permission list. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

Access Groups

ToolPlanAccessSummary
ncentral_create_device_access_groupProWriteCreate a device-based access group.
ncentral_create_org_unit_access_groupProWriteCreate an organization-unit-based access group.
ncentral_get_access_groupFreeRead-onlyGet a single access group by ID — returns name, type (orgUnit or device based), and member list.
ncentral_list_access_groupsFreeRead-onlyList access groups defined at an organization unit.

[N-able N-central] Create a device-based access group. Body identifies the devices to include. Use ncentral_create_org_unit_access_group for the orgUnit-based flavour. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body for the new access group.
orgUnitIdstringyesOrganization unit ID that owns the group.

[N-able N-central] Create an organization-unit-based access group. Body identifies the orgUnits to include. Use ncentral_create_device_access_group for the device-based flavour. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body for the new access group.
orgUnitIdstringyesOrganization unit ID that owns the group.

[N-able N-central] Get a single access group by ID — returns name, type (orgUnit or device based), and member list. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
accessGroupIdstringyesAccess group ID.

[N-able N-central] List access groups defined at an organization unit. Each group bundles a set of orgUnits or devices for use in user-role assignments. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

Job Statuses

ToolPlanAccessSummary
ncentral_list_job_statusesFreeRead-onlyList currently-tracked job statuses for an organization unit.

[N-able N-central] List currently-tracked job statuses for an organization unit. Each entry surfaces job type (patch / script / AMP / maintenance / etc.) and state. Use to confirm whether backend operations are still running. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

Active Issues

ToolPlanAccessSummary
ncentral_list_active_issuesFreeRead-onlyList active issues (open alarms / monitoring notifications) for an organization unit.

[N-able N-central] List active issues (open alarms / monitoring notifications) for an organization unit. Only Customer and Site-tier org-units are supported — passing an SO orgUnitId will 400. Use the convenience tools ncentral_list_active_issues_for_customer / ncentral_list_active_issues_for_site for a self-documenting parameter name. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesCustomer or Site organization unit ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

Registration Tokens

ToolPlanAccessSummary
ncentral_get_customer_registration_tokenFreeRead-onlyGet the appliance-registration token for a specific customer.
ncentral_get_org_unit_registration_tokenFreeRead-onlyGeneric registration-token lookup for an organization unit — supports Customer or Site tier only (SO tier is not supported and will 400).
ncentral_get_site_registration_tokenFreeRead-onlyGet the appliance-registration token for a specific site.

[N-able N-central] Get the appliance-registration token for a specific customer. Embed in a deployment script to auto-register new agents under the customer. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
customerIdstringyesCustomer ID.

[N-able N-central] Generic registration-token lookup for an organization unit — supports Customer or Site tier only (SO tier is not supported and will 400). Functionally equivalent to ncentral_get_customer_registration_token / ncentral_get_site_registration_token when you already know the tier; useful when the caller only has an opaque orgUnitId. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesCustomer or Site organization unit ID.

[N-able N-central] Get the appliance-registration token for a specific site. Embed in a deployment script to auto-register new agents into the site. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
siteIdstringyesSite ID.

Device Tasks

ToolPlanAccessSummary
ncentral_list_scheduled_tasks_for_deviceFreeRead-onlyList scheduled tasks targeted at a specific device.

[N-able N-central] List scheduled tasks targeted at a specific device. Returns task ID, type, and basic status — pair with ncentral_get_scheduled_task / ncentral_get_scheduled_task_status for full detail.

ParamTypeRequiredDefaultDescription
deviceIdstringyesDevice ID.

PSA

ToolPlanAccessSummary
ncentral_get_custom_psa_ticket_infoFreeRead-onlyGet information about a custom-PSA ticket.
ncentral_validate_standard_psa_credentialsProWriteValidate a set of PSA credentials against a standard PSA integration.

[N-able N-central] Get information about a custom-PSA ticket. N-central quirk: this is a POST-as-read because the PSA credentials must be carried in the request body (rather than in the URL). PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
customPsaTicketIdstringyesThe custom-PSA ticket ID.
fieldsJsonstringyesJSON body — the PSA credential payload required to authorize the read.

[N-able N-central] Validate a set of PSA credentials against a standard PSA integration. psaType=3 is the only currently-supported value (Tigerpaw). Body shape mirrors the PSA-specific credential schema. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body — the PSA credential payload to validate.
psaTypestringyesStandard PSA type code. Currently only '3' (Tigerpaw) is supported.

Walk Pagination (Get All)

ToolPlanAccessSummary
ncentral_get_all_access_groupsFreeRead-onlyWalk every page of /api/org-units//access-groups until exhausted or `maxItems` reached.
ncentral_get_all_active_issuesFreeRead-onlyWalk every page of /api/org-units//active-issues until exhausted or `maxItems` reached.
ncentral_get_all_customersFreeRead-onlyWalk every page of /api/customers until exhausted or `maxItems` reached.
ncentral_get_all_customers_under_soFreeRead-onlyWalk every page of /api/service-orgs//customers until exhausted or `maxItems` reached.
ncentral_get_all_device_filtersFreeRead-onlyWalk every page of /api/device-filters until exhausted or `maxItems` reached.
ncentral_get_all_devicesFreeRead-onlyWalk every page of /api/devices until exhausted or `maxItems` reached, returning a combined envelope {data, totalItems, totalPagesWalked, hadMore, timeBudget}.
ncentral_get_all_devices_for_org_unitFreeRead-onlyWalk every page of /api/org-units//devices until exhausted or `maxItems` reached.
ncentral_get_all_org_unit_custom_propertiesFreeRead-onlyWalk every page of /api/org-units//custom-properties until exhausted or `maxItems` reached.
ncentral_get_all_organization_unit_childrenFreeRead-onlyWalk every page of /api/org-units//children until exhausted or `maxItems` reached.
ncentral_get_all_organization_unitsFreeRead-onlyWalk every page of /api/org-units (flat list across all tiers) until exhausted or `maxItems` reached.
ncentral_get_all_service_organizationsFreeRead-onlyWalk every page of /api/service-orgs until exhausted or `maxItems` reached.
ncentral_get_all_sitesFreeRead-onlyWalk every page of /api/sites until exhausted or `maxItems` reached.
ncentral_get_all_sites_under_customerFreeRead-onlyWalk every page of /api/customers//sites until exhausted or `maxItems` reached.
ncentral_get_all_user_rolesFreeRead-onlyWalk every page of /api/org-units//user-roles until exhausted or `maxItems` reached.
ncentral_get_all_users_for_org_unitFreeRead-onlyWalk every page of /api/org-units//users until exhausted or `maxItems` reached.

[N-able N-central] Walk every page of /api/org-units//access-groups until exhausted or `maxItems` reached. Pages are fetched sorted by `groupId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesOrganization unit ID.

[N-able N-central] Walk every page of /api/org-units//active-issues until exhausted or `maxItems` reached. Only Customer/Site orgUnits are supported. Pages are fetched sorted by `taskId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesCustomer or Site organization unit ID.

[N-able N-central] Walk every page of /api/customers until exhausted or `maxItems` reached. Pages are fetched sorted by `customerId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).

[N-able N-central] Walk every page of /api/service-orgs//customers until exhausted or `maxItems` reached. Pages are fetched sorted by `customerId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
soIdstringyesService organization ID.

[N-able N-central] Walk every page of /api/device-filters until exhausted or `maxItems` reached. Pages are fetched sorted by `filterId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
viewScopestringnonullFilter visibility scope: ALL or OWN_AND_USED. Omit for default scope.

[N-able N-central] Walk every page of /api/devices until exhausted or `maxItems` reached, returning a combined envelope {data, totalItems, totalPagesWalked, hadMore, timeBudget}. Pages are fetched sorted by `deviceId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
filterIdstringnonullOptional filter ID from ncentral_list_device_filters to scope results.
maxItemsintegerno5000Maximum total items to return (default 5000). Walks pages until exhausted or this cap.

[N-able N-central] Walk every page of /api/org-units//devices until exhausted or `maxItems` reached. Pages are fetched sorted by `deviceId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
filterIdstringnonullOptional filter ID from ncentral_list_device_filters.
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesOrganization unit ID (SO/Customer/Site).

[N-able N-central] Walk every page of /api/org-units//custom-properties until exhausted or `maxItems` reached. Pages are fetched sorted by `propertyId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesOrganization unit ID.

[N-able N-central] Walk every page of /api/org-units//children until exhausted or `maxItems` reached. Pages are fetched sorted by `orgUnitId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesParent organization unit ID.

[N-able N-central] Walk every page of /api/org-units (flat list across all tiers) until exhausted or `maxItems` reached. Pages are fetched sorted by `orgUnitId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).

[N-able N-central] Walk every page of /api/service-orgs until exhausted or `maxItems` reached. Pages are fetched sorted by `soId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).

[N-able N-central] Walk every page of /api/sites until exhausted or `maxItems` reached. Pages are fetched sorted by `siteId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).

[N-able N-central] Walk every page of /api/customers//sites until exhausted or `maxItems` reached. Pages are fetched sorted by `siteId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
customerIdstringyesCustomer ID.
maxItemsintegerno5000Maximum total items to return (default 5000).

[N-able N-central] Walk every page of /api/org-units//user-roles until exhausted or `maxItems` reached. Pages are fetched sorted by `roleId` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesOrganization unit ID.

[N-able N-central] Walk every page of /api/org-units//users until exhausted or `maxItems` reached. Pages are fetched sorted by `username` ASC (a stable partition; N-central applies NO ordering otherwise) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired), returning a complete sorted prefix; narrow the scope or lower maxItems to finish. This tool can make up to N upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno5000Maximum total items to return (default 5000).
orgUnitIdstringyesOrganization unit ID.

Search & Filter

ToolPlanAccessSummary
ncentral_list_active_issues_for_customerFreeRead-onlyErgonomic alias for ncentral_list_active_issues scoped to a Customer ID.
ncentral_list_active_issues_for_siteFreeRead-onlyErgonomic alias for ncentral_list_active_issues scoped to a Site ID.
ncentral_list_offline_devicesFreeRead-onlyWalks /api/devices and returns devices where `online == false`.
ncentral_list_online_devicesFreeRead-onlyWalks /api/devices and returns devices where `online == true`.
ncentral_list_overdue_devicesFreeRead-onlyWalks /api/devices and returns devices whose `lastApplianceCheckinTime` is older than N hours (default 24).
ncentral_search_customers_by_nameFreeRead-onlyWalks /api/customers and returns customers whose `customerName` contains the supplied substring (case-insensitive).
ncentral_search_devices_by_classFreeRead-onlyWalks /api/devices and returns devices whose `deviceClass` exactly equals the supplied class (case-insensitive) — e.g. WINDOWS_SERVER, WORKSTATION, LINUX, MACOS.
ncentral_search_devices_by_nameFreeRead-onlyWalks /api/devices and returns devices whose `longName` contains the supplied substring (case-insensitive).
ncentral_search_sites_by_nameFreeRead-onlyWalks /api/sites and returns sites whose `siteName` contains the supplied substring (case-insensitive).
ncentral_search_users_by_emailFreeRead-onlyWalks /api/org-units//users and returns users whose `email` contains the supplied substring (case-insensitive).

[N-able N-central] Ergonomic alias for ncentral_list_active_issues scoped to a Customer ID. Returns the same paginated active-issue list. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
customerIdstringyesCustomer ID.
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] Ergonomic alias for ncentral_list_active_issues scoped to a Site ID. Returns the same paginated active-issue list. PREVIEW endpoint — N-able may evolve the response shape.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
siteIdstringyesSite ID.
sortBystringnonullField to sort by.
sortOrderstringnonullSort direction: ASC|DESC.

[N-able N-central] Walks /api/devices and returns devices where `online == false`. Source pages are walked sorted by `deviceId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno1000Maximum total matched items to return (default 1000).

[N-able N-central] Walks /api/devices and returns devices where `online == true`. Source pages are walked sorted by `deviceId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno1000Maximum total matched items to return (default 1000).

[N-able N-central] Walks /api/devices and returns devices whose `lastApplianceCheckinTime` is older than N hours (default 24). Useful for early warning of agents that have stopped reporting. Source pages are walked sorted by `deviceId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
hoursintegerno24Number of hours since last check-in that counts as overdue (default 24).
maxItemsintegerno1000Maximum total matched items to return (default 1000).

[N-able N-central] Walks /api/customers and returns customers whose `customerName` contains the supplied substring (case-insensitive). Source pages are walked sorted by `customerId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno1000Maximum total matched items to return (default 1000).
nameContainsstringyesSubstring to match against the `customerName` (case-insensitive).

[N-able N-central] Walks /api/devices and returns devices whose `deviceClass` exactly equals the supplied class (case-insensitive) — e.g. WINDOWS_SERVER, WORKSTATION, LINUX, MACOS. Source pages are walked sorted by `deviceId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
deviceClassstringyesDevice class (e.g. WINDOWS_SERVER, WORKSTATION, LINUX, MACOS).
maxItemsintegerno1000Maximum total matched items to return (default 1000).

[N-able N-central] Walks /api/devices and returns devices whose `longName` contains the supplied substring (case-insensitive). Use ncentral_get_all_devices for an exhaustive unfiltered walk. Source pages are walked sorted by `deviceId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno1000Maximum total matched items to return (default 1000).
nameContainsstringyesSubstring to match against the device `longName` (case-insensitive).

[N-able N-central] Walks /api/sites and returns sites whose `siteName` contains the supplied substring (case-insensitive). Source pages are walked sorted by `siteId` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxItemsintegerno1000Maximum total matched items to return (default 1000).
nameContainsstringyesSubstring to match against the `siteName` (case-insensitive).

[N-able N-central] Walks /api/org-units//users and returns users whose `email` contains the supplied substring (case-insensitive). Source pages are walked sorted by `username` ASC (a stable partition) under a 120-second walk budget — on expiry the walk stops early with hadMore:true and a non-null `timeBudget` marker {exhausted, budgetSeconds, reason} in the envelope (null when it never expired); matches from unwalked pages are then missing, so narrow the scope and retry. This tool can make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
emailContainsstringyesSubstring to match against the user `email` (case-insensitive).
maxItemsintegerno1000Maximum total matched items to return (default 1000).
orgUnitIdstringyesOrganization unit ID.

Composite Overviews

ToolPlanAccessSummary
ncentral_get_customer_overviewProRead-onlyFan-out composite for a single customer: combines GetCustomer + ListSitesUnderCustomer + ListActiveIssues + ListJobStatuses + GetCustomerRegistrationToken into one envelope {customer, sites,…
ncentral_get_device_overviewProRead-onlyFan-out composite for a single device: combines GetDeviceById + ServiceMonitorStatus + AssetInfo + LifecycleInfo + MaintenanceWindows + ScheduledTasks into one envelope {device, serviceMonitorStatus,…
ncentral_get_org_unit_overviewProRead-onlyFan-out composite for a single organization unit: combines GetOrganizationUnit + ListOrganizationUnitChildren + ListOrgUnitCustomProperties, plus ListActiveIssues for CUSTOMER/SITE units only, into…
ncentral_get_scheduled_task_overviewProRead-onlyFan-out composite for a single scheduled task: combines GetScheduledTask + GetScheduledTaskStatus + ListScheduledTaskStatusDetails into one envelope {task, status, details}.
ncentral_get_site_overviewProRead-onlyFan-out composite for a single site: combines GetSite + walked-devices-for-site + ListActiveIssues into one envelope {site, devices, activeIssues, timeBudget, itemCap}.
ncentral_list_device_asset_detailsProRead-onlyOne page of devices WITH their per-device asset and lifecycle records joined in — serial number, manufacturer/model, OS, plus warranty expiry, lease expiry, expected replacement, purchase date, cost,…

[N-able N-central] Fan-out composite for a single customer: combines GetCustomer + ListSitesUnderCustomer + ListActiveIssues + ListJobStatuses + GetCustomerRegistrationToken into one envelope {customer, sites, activeIssues, jobStatuses, registrationToken}. Issues 5 upstream calls per invocation.

ParamTypeRequiredDefaultDescription
customerIdstringyesCustomer ID to summarize.

[N-able N-central] Fan-out composite for a single device: combines GetDeviceById + ServiceMonitorStatus + AssetInfo + LifecycleInfo + MaintenanceWindows + ScheduledTasks into one envelope {device, serviceMonitorStatus, assetInfo, lifecycle, maintenanceWindows, scheduledTasks}. Issues 6 upstream calls per invocation.

ParamTypeRequiredDefaultDescription
deviceIdstringyesDevice ID to summarize.

[N-able N-central] Fan-out composite for a single organization unit: combines GetOrganizationUnit + ListOrganizationUnitChildren + ListOrgUnitCustomProperties, plus ListActiveIssues for CUSTOMER/SITE units only, into one envelope {orgUnit, children, activeIssues, customProperties}. N-central's active-issues endpoint supports only customers and sites (SYSTEM/SO return HTTP 400), so for non-CUSTOMER/SITE units the activeIssues section is an explicit skipped marker {skipped:true, orgUnitType, reason}. Issues 3 (SYSTEM/SO) or 4 (Customer/Site) upstream calls per invocation.

ParamTypeRequiredDefaultDescription
orgUnitIdstringyesOrganization unit ID to summarize (SO/Customer/Site).

[N-able N-central] Fan-out composite for a single scheduled task: combines GetScheduledTask + GetScheduledTaskStatus + ListScheduledTaskStatusDetails into one envelope {task, status, details}. Issues 3 upstream calls per invocation.

ParamTypeRequiredDefaultDescription
taskIdstringyesScheduled task ID to summarize.

[N-able N-central] Fan-out composite for a single site: combines GetSite + walked-devices-for-site + ListActiveIssues into one envelope {site, devices, activeIssues, timeBudget, itemCap}. The device walk is sorted by `deviceId` ASC and bounded by a 120-second budget — on expiry `timeBudget` is an {exhausted, budgetSeconds, reason} marker (null otherwise) and `devices` is a sorted prefix of the site's fleet; the single-call sections still complete. `itemCap` is an {reached, cap, reason} marker when the site has more devices than the 5000-device walk cap (null otherwise) — `devices` is then a sorted prefix, not the whole fleet. Issues many upstream calls per invocation (device walk is exhaustive up to 5000 items).

ParamTypeRequiredDefaultDescription
siteIdstringyesSite ID to summarize.

[N-able N-central] One page of devices WITH their per-device asset and lifecycle records joined in — serial number, manufacturer/model, OS, plus warranty expiry, lease expiry, expected replacement, purchase date, cost, location and asset tag. Built for fleet inventory / QBR asset reconciliation, where the alternative is calling ncentral_get_device_asset_info and ncentral_get_device_lifecycle_info once per device by hand. Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Pages are ordered by deviceId ascending so consecutive pageNumbers are a stable partition of the fleet — N-central applies NO ordering when a sort is unspecified, which can repeat one device across pages while dropping another. Returns {pageNumber, pageSize, deviceCount, hasMore, totalItems, totalPages, upstreamCallsIssued, unparsedPage, devices:[{deviceId, device, assetInfo, lifecycle}]}; page again with pageNumber+1 while hasMore is true. totalItems/totalPages are the upstream's OWN counts, passed through when it sends them and null otherwise — use them to size the paging job up front. Each section is the vendor body verbatim: per the published schema the serial number is at assetInfo.data.computersystem.serialnumber (DeviceAssetInfoResponse wraps its categories under `data`, though the spec's own example omits that wrapper, so read defensively), while lifecycle is the bare AssetLifecycleDetails object and warranty is lifecycle.warrantyExpiryDate. IMPORTANT — N-central's REST API has NO bulk asset endpoint: serial lives only on /api/devices//assets and warranty/asset-tag/cost only on /api/devices//assets/lifecycle-info, so this tool issues 1 + 2 calls per device upstream against a 300 req/min per-tenant budget. It collapses the AGENT round-trips, not the upstream API calls. pageSize is capped at 50 for that reason. upstreamCallsIssued counts LOGICAL calls: StackJack retries 5xx/408/transport failures, so one logical call can cost up to about 4 HTTP requests against that budget. Set includeAssetInfo=false to drop the serial-number call (and the large installed-application payload) when only warranty/lifecycle fields are needed — that halves the fan-out. Any section that carries no upstream body is an explicit marker with the SAME three keys, {skipped:true, status, reason}: status is the HTTP status when the call was made and refused per-device (403 access group, 404 stale row) and null when no status exists at all (includeAssetInfo=false, a device row with no usable deviceId, or a transport-level fault that never produced one). Only those per-device statuses are isolated — a 401, 408, 429 or 5xx fails the whole call instead, because it will repeat for every remaining device; a transport fault (connection reset, timeout, truncated body) is isolated only once another section has already succeeded on this page, and otherwise fails the call too. unparsedPage is null normally and the same {skipped, status, reason} marker when the device-list response carried no `data` array, so deviceCount:0 is never ambiguous between an empty scope and an unreadable page. If the harness reports tool_result_too_large, lower pageSize — application-heavy fleets can exceed the 5M-character result cap even at 50.

ParamTypeRequiredDefaultDescription
filterIdstringnonullOptional filter ID from ncentral_list_device_filters to scope results.
includeAssetInfobooleannotrueInclude the per-device asset record (default true). This is the ONLY source of serial number, but also the largest payload. Set false for a warranty/lifecycle-only sweep at half the upstream cost.
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.
pageNumberintegerno1Page number, 1-based (default 1). Increment while hasMore is true.
pageSizeintegerno25Devices per page (default 25, max 50). Each device costs up to 2 extra upstream calls, so this is the fan-out bound.

Task Type Wrappers

ToolPlanAccessSummary
ncentral_run_automation_policy_on_deviceProDestructiveDESTRUCTIVE: executes immediately on the target device and can change endpoint state.
ncentral_run_mac_script_on_deviceProDestructiveDESTRUCTIVE: executes immediately on the target macOS device and can change endpoint state.
ncentral_run_script_on_deviceProDestructiveDESTRUCTIVE: executes immediately on the target device and can change endpoint state.

[N-able N-central] DESTRUCTIVE: executes immediately on the target device and can change endpoint state. Trigger an Automation Policy on a single device — it runs now, NOT on a schedule. Thin wrapper over ncentral_create_direct_support_task with taskType=AutomationPolicy. Optional `extraFieldsJson` is merged into the request body for advanced cases (schedule overrides, parameters, etc.).

ParamTypeRequiredDefaultDescription
automationPolicyIdstringyesAutomation Policy ID to execute.
deviceIdstringyesTarget device ID.
extraFieldsJsonstringnonullOptional JSON object to merge into the request body alongside taskType/deviceId/automationPolicyId. Omit when no overrides are needed.

[N-able N-central] DESTRUCTIVE: executes immediately on the target macOS device and can change endpoint state. Trigger a MacScript on a single macOS device — it runs now, NOT on a schedule. Thin wrapper over ncentral_create_direct_support_task with taskType=MacScript. Optional `extraFieldsJson` is merged into the request body for advanced cases (script parameters, schedule overrides, etc.).

ParamTypeRequiredDefaultDescription
deviceIdstringyesTarget macOS device ID.
extraFieldsJsonstringnonullOptional JSON object to merge into the request body alongside taskType/deviceId/macScriptId. Omit when no overrides are needed.
macScriptIdstringyesMacScript ID to execute.

[N-able N-central] DESTRUCTIVE: executes immediately on the target device and can change endpoint state. Trigger a script (Windows / PowerShell) on a single device — it runs now, NOT on a schedule. Thin wrapper over ncentral_create_direct_support_task with taskType=Script. Optional `extraFieldsJson` is merged into the request body for advanced cases (script parameters, schedule overrides, etc.).

ParamTypeRequiredDefaultDescription
deviceIdstringyesTarget device ID.
extraFieldsJsonstringnonullOptional JSON object to merge into the request body alongside taskType/deviceId/scriptId. Omit when no overrides are needed.
scriptIdstringyesScript ID to execute.

Premium Reports

ToolPlanAccessSummary
ncentral_report_active_issues_summary_by_severityProRead-onlyWalks active issues for a Customer/Site orgUnit and produces a severity-grouped count.
ncentral_report_appliance_health_summaryProRead-onlyWalks every device in the account, or in the given organization unit, and pulls service-monitor status.
ncentral_report_asset_inventory_summaryProRead-onlyWalks every device in the account, or in the given organization unit, fetches asset info, and produces an OS / manufacturer distribution.
ncentral_report_compliance_custom_property_coverageProRead-onlyFor a given device custom-property ID, walks every device in the account, or in the given organization unit, and returns the % populated (non-null/non-empty value).
ncentral_report_devices_offline_summaryProRead-onlyWalks every device in the account, or in the given organization unit, and produces an offline-device count grouped by customerId and siteId.
ncentral_report_maintenance_window_coverageProRead-onlyWalks every device in the account, or in the given organization unit, fetches each one's maintenance windows, and returns the % of devices with at least one window configured.
ncentral_report_overdue_check_insProRead-onlyWalks every device in the account, or in the given organization unit, and returns those whose `lastApplianceCheckinTime` is older than N hours (default 24), grouped by customer.
ncentral_report_scheduled_task_recent_failuresProRead-onlyWalks the scheduled tasks of every device in the account, or in the given organization unit, pulls status detail for each, and returns failed entries from the last N hours (default 24).
ncentral_report_user_access_auditProRead-onlyFor a given orgUnit, walks users + user roles + access groups and returns a per-user record listing their role assignments and any access-group memberships.
ncentral_report_warranty_expiring_in_daysProRead-onlyWalks every device in the account, or in the given organization unit, fetches lifecycle info, and returns devices whose warranty expires within N days (default 60).

[N-able N-central] Walks active issues for a Customer/Site orgUnit and produces a severity-grouped count. Returns {orgUnitId, totalIssues, bySeverity: , timeBudget, itemCap}. The issue walk is sorted by `taskId` ASC and bounded by a 120-second budget — on expiry `timeBudget` is an {exhausted, budgetSeconds, reason} marker (null otherwise) and counts cover only the issues collected before it expired. If the walk stops at the maxIssues cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxIssuesintegerno5000Maximum number of issues to inspect (default 5000).
orgUnitIdstringyesCustomer or Site organization unit ID.

[N-able N-central] Walks every device in the account, or in the given organization unit, and pulls service-monitor status. Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, devicesInspected, byState, timeBudget, itemCap} — a count grouped by status (NORMAL / WARNING / FAILED / ...). The whole report shares one 120-second budget across its device walk (sorted by `deviceId` ASC) and the per-device calls — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and results cover only the devices inspected before it expired; lower maxDevices or scope the report to finish. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.

[N-able N-central] Walks every device in the account, or in the given organization unit, fetches asset info, and produces an OS / manufacturer distribution. Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, devicesInspected, byOs, byManufacturer, timeBudget, itemCap}. The whole report shares one 120-second budget across its device walk (sorted by `deviceId` ASC) and the per-device calls — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and results cover only the devices inspected before it expired; lower maxDevices or scope the report to finish. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.

[N-able N-central] For a given device custom-property ID, walks every device in the account, or in the given organization unit, and returns the % populated (non-null/non-empty value). Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, propertyId, devicesInspected, populated, missing, coveragePercent, timeBudget, itemCap}. The whole report shares one 120-second budget across its device walk (sorted by `deviceId` ASC) and the per-device calls — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and results cover only the devices inspected before it expired; lower maxDevices or scope the report to finish. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.
propertyIdstringyesDevice custom-property ID to evaluate coverage on.

[N-able N-central] Walks every device in the account, or in the given organization unit, and produces an offline-device count grouped by customerId and siteId. Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, totalOffline, totalDevices, byCustomer: [...], bySite: [...], timeBudget, itemCap}. The device walk is sorted by `deviceId` ASC and bounded by a 120-second budget — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and counts cover only the devices collected before it expired. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.

[N-able N-central] Walks every device in the account, or in the given organization unit, fetches each one's maintenance windows, and returns the % of devices with at least one window configured. Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, devicesInspected, withWindow, withoutWindow, coveragePercent, timeBudget, itemCap}. The whole report shares one 120-second budget across its device walk (sorted by `deviceId` ASC) and the per-device calls — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and results cover only the devices inspected before it expired; lower maxDevices or scope the report to finish. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.

[N-able N-central] Walks every device in the account, or in the given organization unit, and returns those whose `lastApplianceCheckinTime` is older than N hours (default 24), grouped by customer. Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, totalOverdue, totalDevices, byCustomer: [{customerId, overdue, devices: [...]}], timeBudget, itemCap}. The device walk is sorted by `deviceId` ASC and bounded by a 120-second budget — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and counts cover only the devices collected before it expired. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
hoursintegerno24Number of hours since last check-in that counts as overdue (default 24).
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.

[N-able N-central] Walks the scheduled tasks of every device in the account, or in the given organization unit, pulls status detail for each, and returns failed entries from the last N hours (default 24). Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, windowHours, devicesInspected, failures: [{deviceId, taskId, ...}], timeBudget, itemCap}. The whole report shares one 120-second budget across its device walk (sorted by `deviceId` ASC) and the per-device calls — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and results cover only the devices inspected before it expired; lower maxDevices or scope the report to finish. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
hoursintegerno24Hours window to inspect (default 24).
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.

[N-able N-central] For a given orgUnit, walks users + user roles + access groups and returns a per-user record listing their role assignments and any access-group memberships. Returns {orgUnitId, users: [{userId, email, name, roles: [...], accessGroups: [...]}], totals, timeBudget, itemCap}. The three walks (sorted by `username` / `roleId` / `groupId` ASC) share a 120-second budget — on expiry `timeBudget` is an {exhausted, budgetSeconds, reason} marker (null otherwise) and the totals cover only the walked pages. If the walk stops at the maxUsers cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
maxUsersintegerno5000Maximum number of users to inspect (default 5000).
orgUnitIdstringyesOrganization unit ID.

[N-able N-central] Walks every device in the account, or in the given organization unit, fetches lifecycle info, and returns devices whose warranty expires within N days (default 60). Omit orgUnitId for the whole tenant, or pass an SO/Customer/Site orgUnitId to scope it. Returns {orgUnitId, devicesInspected, withinDays, expiring, timeBudget, itemCap}. The whole report shares one 120-second budget across its device walk (sorted by `deviceId` ASC) and the per-device calls — on expiry the envelope's `timeBudget` key is an {exhausted, budgetSeconds, reason} marker (null otherwise) and results cover only the devices inspected before it expired; lower maxDevices or scope the report to finish. If the walk stops at the maxDevices cap with more items available upstream, the envelope's `itemCap` key is an {reached, cap, reason} marker (null otherwise) and the results cover only the capped, sorted prefix. This tool may make many upstream API calls; rate-limited per tenant.

ParamTypeRequiredDefaultDescription
daysintegerno60Number of days from today to consider "expiring" (default 60).
maxDevicesintegerno5000Maximum number of devices to inspect (default 5000).
orgUnitIdstringnonullOrganization unit ID (SO/Customer/Site) to scope to. Omit for the whole tenant.