Home

Welcome to the PS-NCentral-RESTAPI wiki!

Below you will find a list of all API Endpoints with (if created) links to pages explaining the corresponding Powershell CMDlet end it shows if pagination is available and implemented as well as sorting and selecting specific field. If there is no check or x in the corresponding column, the API endpoint doesn't support that feature

API Categories

Access Groups

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
POST	/api/org-units/{orgUnitId}/device-access-groups	✔️	✔️
GET	/api/org-units/{orgUnitId}/access-groups	✔️	✔️	✔️	✔️	❌
POST	/api/org-units/{orgUnitId}/access-groups	✔️	✔️
GET	/api/access-groups	❌	✔️
GET	/api/access-groups/{accessGroupId}	✔️	✔️

Active Issues

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
GET	/api/org-units/{orgUnitId}/active-issues	✔️	✔️	✔️	✔️	❌

API-Service

API Category	API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
POST	/api/server-info/extra/authenticated	❌	✔️
GET	/api	❌
GET	/api/server-info	✔️
GET	/api/server-info/extra	✔️	✔️
GET	/api/health	✔️

Authentication

API Category	API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
POST	/api/auth/refresh	✔️
POST	/api/auth/authenticate	✔️
GET	/api/auth	❌
GET	/api/auth/validate	✔️

Custom Properties

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
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	/api/org-units/{orgUnitId}/custom-properties/device-custom-property-defaults/{propertyId}	✔️	✔️
GET	/api/devices/{deviceId}/custom-properties	✔️	✔️

Device Filters

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
GET	/api/device-filters	✔️	✔️	✔️	✔️	❌

Device Tasks

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
GET	/api/devices/{deviceId}/scheduled-tasks	✔️

Devices

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
GET	/api/devices/{deviceId}/assets/lifecycle-info	✔️
PUT	/api/devices/{deviceId}/assets/lifecycle-info	✔️
PATCH	/api/devices/{deviceId}/assets/lifecycle-info	✔️
POST	/api/device	✔️	✔️
GET	/api/org-units/{orgUnitId}/devices	✔️	✔️	✔️	✔️	❌
GET	/api/devices	✔️		✔️	✔️	❌
GET	/api/devices/{deviceId}	✔️
GET	/api/devices/{deviceId}/service-monitor-status	✔️	✔️
GET	/api/devices/{deviceId}/assets	✔️
GET	/api/devices/{deviceId}/activation-key	✔️
GET	/api/appliance-tasks/{taskId}	✔️

Job Statuses

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
GET	/api/org-units/{orgUnitId}/job-statuses	✔️	✔️

Maintenance Windows

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
PUT	/api/devices/maintenance-windows	✔️	✔️
POST	/api/devices/maintenance-windows	✔️	✔️
DELETE	/api/devices/maintenance-windows	✔️	✔️
GET	/api/devices/{deviceId}/maintenance-windows	✔️	✔️

Organisation Units

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select
GET	/api/service-orgs	✔️		✔️	✔️	❌
POST	/api/service-orgs	✔️	✔️
GET	/api/service-orgs/{soId}/customers	✔️	✔️	✔️	✔️	❌
POST	/api/service-orgs/{soId}/customers	✔️	✔️
GET	/api/customers/{customerId}/sites	✔️	✔️	✔️	✔️	❌
POST	/api/customers/{customerId}/sites	✔️	✔️
GET	/api/sites	✔️		❌	❌	❌
GET	/api/sites/{siteId}	✔️	✔️
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}	✔️	✔️

API Type	API Endpoint	Implementable	Preview	Pagination	Sorting	Output field select