Owner's Manual

3 REST API Guide – OpenManage Essentials | Version 1.0
Table of contents
Revisions ............................................................................................................................................................................................. 2
Introduction ....................................................................................................................................................................................... 5
1 Key Integration Concepts......................................................................................................................................................... 6
1.1 Client Integration Overview .......................................................................................................................................... 6
1.2 Base URI ............................................................................................................................................................................ 6
1.3 Security ............................................................................................................................................................................. 7
1.4 Authentication Mechanisms .......................................................................................................................................... 7
1.5 Resource Addressing ...................................................................................................................................................... 7
1.6 Resource Operations ...................................................................................................................................................... 8
1.7 Data Filtering And Sorting .............................................................................................................................................. 8
1.8 Data Pagination ............................................................................................................................................................... 9
1.9 Request Headers ............................................................................................................................................................. 9
1.10 Response Codes............................................................................................................................................................ 10
1.12 Response Headers ......................................................................................................................................................... 11
2 OME- Specific Resource Model ............................................................................................................................................. 12
2.1 Device Groups ............................................................................................................................................................... 12
2.2 Devices ............................................................................................................................................................................ 14
2.2.1 Devices By Direct Access :< BASE_URI>/Devices ................................................................................................... 16
2.2.2 Changed Device Information ..................................................................................................................................... 18
2.3 Device Inventory ........................................................................................................................................................... 18
2.3.1 Firmware ......................................................................................................................................................................... 19
2.3.2 Processor ........................................................................................................................................................................ 19
2.3.3 NICs ................................................................................................................................................................................. 19
2.3.4 Operating Systems ........................................................................................................................................................ 20
2.3.5 Memory ........................................................................................................................................................................... 20
2.3.6 Software Inventory ........................................................................................................................................................ 21
2.3.7 Agent Information ......................................................................................................................................................... 22
2.3.8 Contact Information ..................................................................................................................................................... 23
2.3.9 Device Capabilities ........................................................................................................................................................ 24
2.3.10 All Inventory .............................................................................................................................................................. 25
2.4 Device Group Hierarchy .............................................................................................................................................. 25