API Guide

Contents
1 Overview........................................................................................................................10
Other Documents You May Need......................................................................................................................................10
2 Resource URI Endpoints.................................................................................................11
3 Authentication Headers................................................................................................. 12
4 Generic Query Parameters.............................................................................................14
Dates in query strings........................................................................................................................................................14
5 HTTP Message Bodies.................................................................................................. 15
Validations.........................................................................................................................................................................15
6 Usage Examples............................................................................................................ 16
Timezone.......................................................................................................................................................................... 16
Get the current timezone............................................................................................................................................16
Set the current timezone............................................................................................................................................ 16
Credential..........................................................................................................................................................................17
Get all dened Credentials...........................................................................................................................................17
Dene new Credential................................................................................................................................................. 17
DiscoveryRequest............................................................................................................................................................. 17
Discover Chassis and contained Blade Servers........................................................................................................... 18
ManagedDevice................................................................................................................................................................ 18
Get all Managed Devices.............................................................................................................................................18
ServiceTemplate................................................................................................................................................................19
Get all ServiceTemplates............................................................................................................................................. 19
Get a ServiceTemplate by name..................................................................................................................................19
Publish a ServiceTemplate..........................................................................................................................................20
Deployment......................................................................................................................................................................20
Get all deployed Services........................................................................................................................................... 20
Deploy a new Service..................................................................................................................................................21
Tear down a Service....................................................................................................................................................21
Firmware.......................................................................................................................................................................... 22
Check Firmware compliance of all Resources............................................................................................................. 22
7 Exception Handling........................................................................................................23
8 Appendix A - API Reference.......................................................................................... 24
/AddOnModule.................................................................................................................................................................24
/AddOnModule.................................................................................................................................................................24
/AddOnModule/{id}......................................................................................................................................................... 25
/Authenticate/................................................................................................................................................................. 26
3