API and Command Reference¶
This section is a reference to the MPS API methods available in the Open AMT Cloud Toolkit, and to some commands it provides.
There are two types of method paths for the MPS Server:
- AMT path methods - Allow you to send device-specific calls for things such as power actions or audit logs. Utilize these methods by setting the path to amt in your API call.
- Admin path methods - Allow you to send calls for info for all devices or for MPS configuration information. Utilize these methods by setting the path to admin in your API call.
Steps on how to create your own Rest API call can be found in the Construct a Rest API Call tutorial.
How to Use the REST API¶
Request URL¶
The request URL is assembled using your MPS server's IP Address, the port, and the base path for the method you would like to run. The tables below explore what methods are accessible for each base path.
Example url: https://localhost:3000/amt
Base paths¶
/amt/
/admin/
API Calls¶
The sections below list methods for MPS.
The MPS API includes Admin and AMT methods.
Admin Methods¶
| Method | Description/Usage |
|---|---|
| AllDevices | Lists all devices known to MPS, regardless of connected status |
| ConnectedDevices | Lists all devices currently connected to MPS |
| Disconnect | Disconnects the CIRA connection for a specified guid |
| MEScript | Downloads the cira_setup.mescript from MPS |
| RootCertificate | Download the MPS Root Certificate |
AMT Methods¶
Note
These methods are 1:1 device-specific.
| Method | Description/Usage |
|---|---|
| AuditLog | Returns a requested amount or time range of Intel® AMT Audit Log data for a specified guid |
| EventLog | Return sensor and hardware event data |
| GeneralSettings | View general network settings |
| GetAMTFeatures | View what AMT out-of-band features are enabled/disabled |
| HardwareInfo | Retrieve hardware information such as processor or storage |
| PowerAction | Perform an OOB power action |
| PowerCapabilities | View what OOB power actions are available for that device |
| PowerState | Retrieve current state of AMT device, returns a number that maps to the PowerActions table |
| SetAMTFeatures | Enable/Disable AMT features such as KVM, SOL, and IDE-R |
| Version | Retrieve AMT version of device |