API Guide

1 About this document................................................................................................................... 12
2 Overview....................................................................................................................................13
RESTful application programming interface..................................................................................................................... 13
OData.....................................................................................................................................................................................13
JSON data.............................................................................................................................................................................13
HTTPS communication........................................................................................................................................................13
OpenManage Enterprise - Modular Edition...................................................................................................................... 13
OpenManage Enterprise..................................................................................................................................................... 14
3 Key integration concepts.............................................................................................................15
Base URI................................................................................................................................................................................15
OEM scheme.................................................................................................................................................................. 15
Redfish scheme.............................................................................................................................................................. 17
Security..................................................................................................................................................................................17
Authentication.......................................................................................................................................................................17
Authorization.........................................................................................................................................................................18
Resource addressing...........................................................................................................................................................20
Resource operations............................................................................................................................................................ 21
Security considerations....................................................................................................................................................... 21
Data filtering..........................................................................................................................................................................21
Data sorting..........................................................................................................................................................................22
Data pagination....................................................................................................................................................................22
Request headers..................................................................................................................................................................22
Response codes...................................................................................................................................................................23
Response headers............................................................................................................................................................... 23
4 Application settings....................................................................................................................25
Network................................................................................................................................................................................25
/api/ApplicationService/Network...............................................................................................................................25
/api/ApplicationService/Network/CurrentAddressConfiguration......................................................................... 26
/api/ApplicationService/Network/AddressConfiguration.......................................................................................27
/api/ApplicationService/Network/WebServerConfiguration................................................................................. 30
/api/ApplicationService/Network/TimeConfiguration............................................................................................. 31
/api/ApplicationService/Network/TimeZones......................................................................................................... 32
/api/ApplicationService/Network/ProxyConfiguration...........................................................................................33
Security and user management.........................................................................................................................................34
/api/AccountService.....................................................................................................................................................34
/api/AccountService/Accounts.................................................................................................................................. 37
/api/AccountService/Accounts(Id)........................................................................................................................... 39
/api/AccountService/Accounts(userId)/Permissions..............................................................................................41
/api/AccountService/Actions/AccountService.Enable...........................................................................................42
/api/AccountService/Actions/AccountService.Disable.......................................................................................... 42
/api/AccountService/Actions/AccountService.Delete........................................................................................... 43
Contents
Contents 3