Jump to Content
Guides
Recipes
API Reference
Changelog
v1.0
Guides
API Reference
Recipes
Changelog
API Reference
Guides
API Reference
Recipes
Changelog
v1.0
Guides
Recipes
API Reference
Changelog
Retrieve a list of all sites.
All
Pages
Start typing to search…
JUMP TO
N-central API-Service
Authentication
Obtains access and refresh tokens using an N-central User-API Token (JWT).
post
Obtains a new API-Access token using a valid refresh token.
post
List the authentication-related links.
get
Check the validity of the API-Access token.
get
API-Service
PREVIEW: Get extra information about the version of different systems in N-central using credentials.
post
List links to other endpoints.
get
Return version information of the running API-Service.
get
PREVIEW: Get information about the version of different systems in N-central.
get
Return the start and current time of the server. This indicates that the server is running.
get
Devices
Retrieve a device asset lifecycle information by Device ID.
get
Modifies the Asset Lifecycle Information by Device Id.
put
Modifies the Asset Lifecycle Information by Device Id.
patch
PREVIEW : Retrieve the list of devices by org unit id.
get
Retrieve the list of devices.
get
Retrieve a device by ID.
get
PREVIEW : Retrieves the status of the service monitoring tasks for a given device.
get
Retrieve Asset Information for a device by ID.
get
PREVIEW : Retrieves the appliance-task information.
get
Organization Units
Retrieve a list of all service organizations.
get
PREVIEW: Creates a new service organization (SO).
post
PREVIEW: Retrieve a list of all customers under a service organization.
get
PREVIEW: Creates a customer.
post
PREVIEW: Retrieve a list of sites under a customer.
get
PREVIEW: Creates a site.
post
Retrieve a list of all sites.
get
PREVIEW: Retrieve a site.
get
PREVIEW: Retrieve a service organization.
get
Retrieve a list of all organization units.
get
PREVIEW: Retrieve an organization unit.
get
PREVIEW: Retrieve a list of all organization units children.
get
Retrieve a list of all customers.
get
PREVIEW: Retrieve a customer.
get
Device Filters
PREVIEW: Retrieve the list of filters.
get
Custom Properties
PREVIEW: Update the default organization unit custom property.
put
PREVIEW: Get the organization unit custom property.
get
PREVIEW: Update the organization unit custom property.
put
PREVIEW: Get the device custom property.
get
PREVIEW: Modify Device Custom Property
put
PREVIEW: Get the organization unit custom property.
get
PREVIEW: Get the list of organization custom properties.
get
PREVIEW: Retrieve Device Default Custom Property information by organization unit id and property id
get
PREVIEW: Retrieve Device Custom Properties by device id
get
Scheduled Tasks
Create a direct-support schedule task.
post
List the task-related links.
get
Retrieves general information for a given task.
get
Retrieves aggregated status for a given task.
get
Retrieves detailed status per device for a given task.
get
Maintenance Windows
PREVIEW : Adds set of maintenance windows for a list of given devices.
post
PREVIEW : Deletes device patch maintenance windows by given list of Schedule Ids.
del
PREVIEW : Retrieves all maintenance windows for a device.
get
Users
PREVIEW: List the user related links.
get
PREVIEW: Retrieve the list of users.
get
User Roles
PREVIEW: Retrieve a list of user roles for a given organization unit.
get
PREVIEW: Add a new user role for a given organization unit.
post
PREVIEW: Retrieve a user role for a given organization unit and user role id.
get
Access Groups
PREVIEW: Creates a new device type access group.
post
PREVIEW: Retrieve Access Groups Information for an Org Unit by ID.
get
PREVIEW: Creates a new organization unit type access group.
post
PREVIEW: List the access group related links.
get
PREVIEW: Retrieve detailed information for a specific Access Group by ID.
get
Job Statuses
PREVIEW: Fetch job statuses
get
Active Issues
PREVIEW: Fetch active issues
get
Registration Tokens
PREVIEW: Retrieve a site registration token.
get
PREVIEW: Retrieve a organization unit registration token.
get
PREVIEW: Retrieve a customer registration token.
get
Device Tasks
Retrieve tasks for a specific device.
get
PSA
PREVIEW: Validate Standard PSA Credentials.
post
PREVIEW: Retrieve detailed information for a specific Custom PSA Ticket by ID.
post
PREVIEW: List the standard psa related links.
get
PREVIEW: List the custom psa related links.
get
PREVIEW: List the custom psa tickets related links.
get
Powered by
Retrieve a list of all sites.
Ask AI
get
https://{custom-server}/api/sites
Returns a list of all sites.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
custom-server
/api/sites
Response
Click
Try It!
to start a request and see the response here!