Hardware | ArcGIS REST APIs

URL:: https://<root>/machines/<machine>/hardware
Methods:: GET
Version Introduced:: 12.0

Description

The hardware resource displays hardware information for a specified machine in your server site.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The output format for this operation. The default value is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

f

(Required)

The output format for this operation. The default value is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Response properties

Property	Details
`numLogicalProcessors`	Returns the number of logical processors available on the machine.
`systemMemoryAvailableMB`	Outputs the amount of memory (RAM) currently available on a given machine in MB.
`os`	Outputs the operating system version and build being run on the machine.
`cpu`	Returns the name of the machine's CPU along with its number of physical CPU cores, logical CPU cores, and the processor name.
`systemMemoryMB`	Returns the amount of memory (RAM) accessible by the machine.
`gpu`	Outputs the name of the GPU, its total memory, and free memory.
`numPhysicalProcessors`	Shows the number of physical processors are available on the machine.
`localDiskUsage`	The `localDiskUsage` JSON object contains the following properties: `diskTotalSpaceGB`: Indicates the total amount of storage on a machine. `diskUsableSpaceGB`: Indicates how much storage space remains on a machine. `exceededDiskSpaceThreshold`: Shows `true` or `false` depending on whether the maximum storage size has been exceeded. This occurs when there is too little storage remaining to safely publish new services. `mount`: Shows the mount point of the storage in question described above.

Example usage

The following is a sample request URL used to access the hardware resource:

Use dark colors for code blocksCopy
https://organization.example.com/video/admin/machines/organization.example.com/hardware?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
    "numLogicalProcessors": "integer",
    "systemMemoryAvailableMB": "integer",
    "os": "Operating System build",
    "cpu": "CPU name and clock speed, physical CPU package(s), physical CPU core(s), logical CPU(s), Identifier, ProcessorID, Microarchitecture",
    "systemMemoryMB": "integer",
    "gpu": "Processor Name, Total Memory (MB), Free Memory (MB)",
    "numPhysicalProcessors": "integer",
    "localDiskUsage": [{
        "diskTotalSpaceGB": "integer",
        "diskUsableSpaceGB": "integer",
        "exceededDiskSpaceThreshold": "<true | false>",
        "mount": "Mount drive"
    }]
}

JSON Response example

Use dark colors for code blocksCopy
{
    "numLogicalProcessors": 12,
    "systemMemoryAvailableMB": 31467,
    "os": "Microsoft Windows 11 build 26100",
    "cpu": "Intel(R) Core(TM) i7-10850H CPU @ 2.70GHz\n 1 physical CPU package(s)\n 6 physical CPU core(s)\n 12 logical CPU(s)\nIdentifier: Intel64 Family 6 Model 165 Stepping 2\nProcessorID: BFEBFBFF000A0652\nMicroarchitecture: Comet Lake",
    "systemMemoryMB": 65241,
    "gpu": "Processor Name: Quadro T1000, Total Memory (MB): 4096, Free Memory (MB): 2827",
    "numPhysicalProcessors": 6,
    "localDiskUsage": [{
        "diskTotalSpaceGB": 943,
        "diskUsableSpaceGB": 179,
        "exceededDiskSpaceThreshold": false,
        "mount": "C:\\"
    }]
}