- URL:
- https://<root>/machines/<machine>/hardware
- Methods:
GET- Version Introduced:
- 10.6.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The hardware resource displays hardware information for a specified machine in your server site. It updates the information when it detects any change to the configuration of your machine, as well as each time the machine is restarted.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| The specifications of the machine's central processing unit (CPU). |
| The current operating system of the machine. |
| The amount of system memory in megabytes. |
| The number of physical cores in the CPU. |
| The number of logical cores in the CPU. This value is the number of physical cores multiplied by the number of threads each core can run via hyperthreading. |
Example usage
The following is a sample request URL used to access the hardware resource:
https://organization.example.com/<context>/admin/machines/MACHINE.EXAMPLE.COM/hardware?f=pjsonJSON Response example
{
"cpu": "Intel(R) Xeon(R) CPU E5-2698 v3 @ 3.50GHz",
"os": "Microsoft Windows 10 build 10586",
"systemMemoryMB": 16306,
"numPhysicalProcessors": 4,
"numLogicalProcessors": 8
}