PS-NCentral-RESTAPI

This module will be expanded to allow for the full range of N-Central Rest API functions to be included.

Powershell Gallery

This module is published on the powershell gallery, however the version on Powershell Gallery my not be the same as the version on GitHub. The Powershell Gallery version can be found at Powershell Gallery

PREVIEW API Endpoints

Warning

All endpoints that are currently marked as preview in the API of N-Central, will always output a warning on the console stating that the endpoint is still a preview.

Remaining Categories

The list below is based on the NFR unit running N-Central 2026.1.0.503 provided by N-Able.

Behind each category is a number defining how many API endpoints are remaining of the total number of API endpoints are in that category

• Access Groups (2/5)
  • POST /api/org-units/{orgUnitId}/device-access-groups
  • GET /api/org-units/{orgUnitId}/access-groups > Get-NcentralAccessGroups
  • POST /api/org-units/{orgUnitId}/access-groups
  • GET /api/access-groups > won't be implemented as it only returns a list of available endpoints
  • GET /api/access-groups/{accessGroupId} > Get-NcentralAccessGroup
• Active Issues (0/1)
  • GET /api/org-units/{orgUnitId}/active-issues > Get-NcentralActiveIssues
• API-Service (0/5)
  • POST /api/server-info/extra/authenticated > Won't be implemented as it's a duplicate of the API Endpoint /api/server-info/extra with extra steps.
  • GET /api > won't be implemented as it only returns a list of available endpoints
  • GET /api/server-info > Get-NcentralApiServerInfo
  • GET /api/server-info/extra > Get-NCentralApiServerInfoExtra
  • GET /api/health > Get-NcentralApiServerHealth
• Authentication (0/4)
  • POST /api/auth/refresh > Get-NcentralAuthenticationRefresh
  • POST /api/auth/authenticate > Connect-Ncentral
  • GET /api/auth > won't be implemented as it only returns a list of available endpoints
  • GET /api/auth/validate > Get-NcentralAuthenticationValidation
• Custom Properties (8/9)
  • PUT /api/org-units/{orgUnitId}/org-custom-property-defaults
  • GET /api/org-units/{orgUnitId}/custom-properties/{propertyId}
  • PUT /api/org-units/{orgUnitId}/custom-properties/{propertyId}
  • GET /api/devices/{deviceId}/custom-properties/{propertyId}
  • PUT /api/devices/{deviceId}/custom-properties/{propertyId}
  • GET /api/org-units/{orgUnitId}/org-custom-property-defaults/{propertyId}
  • GET /api/org-units/{orgUnitId}/custom-properties > Get-NcentralCustomProperties
  • GET /api/org-units/{orgUnitId}/custom-properties/device-custom-property-defaults/{propertyId}
  • GET /api/devices/{deviceId}/custom-properties
• Device Filters (0/1)
  • GET /api/device-filters > Get-NcentralDeviceFilters
• Device Tasks (0/1)
  • GET /api/devices/{deviceId}/scheduled-tasks > Get-NcentralDeviceTasks
• Devices (4/12)
  • GET /api/devices/{deviceId}/assets/lifecycle-info > Get-NcentralDeviceAssetsLifecycleInfo
  • PUT /api/devices/{deviceId}/assets/lifecycle-info
  • PATCH /api/devices/{deviceId}/assets/lifecycle-info
  • POST /api/device
  • GET /api/org-units/{orgUnitId}/devices > Get-NcentralDevices
  • GET /api/devices > Get-NcentralDevices
  • GET /api/devices/{deviceId} > Get-NcentralDevice
  • DELETE /api/devices/{deviceId}
  • GET /api/devices/{deviceId}/service-monitor-status > Get-NcentralDeviceServiceMonitorStatus
  • GET /api/devices/{deviceId}/assets > Get-NcentralDeviceAssets
  • GET /api/devices/{deviceId}/activation-key > Get-NcentralDeviceActivationKey
  • GET /api/appliance-tasks/{taskId}
• Job Statuses (1/1)
  • GET /api/org-units/{orgUnitId}/job-statuses
• Maintenance Windows (3/4)
  • PUT /api/devices/maintenance-windows
  • POST /api/devices/maintenance-windows
  • DELETE /api/devices/maintenance-windows
  • GET /api/devices/{deviceId}/maintenance-windows > Get-NcentralMaintenanceWindows
• Organisation Units (11/14)
  • GET /api/service-orgs > Get-NcentralServiceOrganisations
  • POST /api/service-orgs
  • GET /api/service-orgs/{soId}/customers > Get-NcentralServiceOrganisationsCustomers
  • POST /api/service-orgs/{soId}/customers > New-NcentralCustomer
  • GET /api/customers/{customerId}/sites > Get-NcentralCustomerSites
  • POST /api/customers/{customerId}/sites
  • GET /api/sites > Get-NcentralSites
  • GET /api/sites/{siteId} > Get-NcentralSite
  • GET /api/service-orgs/{soId}
  • GET /api/org-units
  • GET /api/org-units/{orgUnitId}
  • GET /api/org-units/{orgUnitId}/children
  • GET /api/customers
  • GET /api/customers/{customerId}
• Patch Reports (0/2)
  • POST /api/report/patch-comparison
  • GET /api/report/{reportId}
• PSA (2/6)
  • POST /api/standard-psa/{psaType}/credential
  • POST /api/custom-psa/tickets/{customPsaTicketId}
  • GET /api/standard-psa > won't be implemented as it only returns a list of available endpoints
  • GET /api/standard-psa/customer-mapping/{customerId}
  • GET /api/custom-psa > won't be implemented as it only returns a list of available endpoints
  • GET /api/custom-psa/tickets > won't be implemented as it only returns a list of available endpoints
• Registration Tokens (0/3)
  • GET /api/sites/{siteId}/registration-token > Get-NcentralRegistrationToken
  • GET /api/org-units/{orgUnitId}/registration-token > Get-NcentralRegistrationToken
  • GET /api/customers/{customerId}/registration-token > Get-NcentralRegistrationToken
• Scheduled Tasks (1/5)
  • POST /api/scheduled-tasks/direct
  • GET /api/scheduled-tasks > won't be implemented as it only returns a list of available endpoints
  • GET /api/scheduled-tasks/{taskId} > Get-NcentralScheduledTask
  • GET /api/scheduled-tasks/{taskId}/status > Get-NcentralScheduledTaskStatus
  • GET /api/scheduled-tasks/{taskId}/status/details > Get-NcentralScheduledTaskStatusDetails
• Software Installers (0/2)
  • GET /api/customers/{customerId}/software/installers
  • POST /api/customers/{customerId}/software/installers
• User Roles (1/3)
  • GET /api/org-units/{orgUnitId}/user-roles > Get-NcentralUserRoles
  • POST /api/org-units/{orgUnitId}/user-roles
  • GET /api/org-units/{orgUnitId}/user-roles/{userRoleId} > Get-NcentralUserRoles
• Users (0/2)
  • GET /api/users > won't be implemented as it only returns a list of available endpoints
  • GET /api/org-units/{orgUnitId}/users > Get-NcentralUsers

Total Endpoints: 80

Finished Endpoints (including the endpoints that won't be implemented): 44

Future enhancements

Currently not all API endpoints are built into this module. The missing endpoints are still being added to this module. None of the endpoints that have paging, have the sortby and select parameter implemented. This still has to be implemented.

Contribute

If you would like to contribute, then please read our CONTRIBUTING document

Authors

• eagle00789
• CasperStekelenburg