API Guide

Table Of Contents

Key integration concepts

This section describes the key integration concepts that are applicable to the use cases and resource model.

Topics:

• Base URI

• Security

• Authentication

• Authorization

• Resource addressing

• Resource operations

• Security considerations

• Data filtering

• Data sorting

• Data pagination

• Request headers

• Response codes

• Response headers

Base URI

REST API tree structure

The console software provides a web-based hypermedia driven API using a simple folder structure. The client that is provided

with the Service Root URI navigates through the entire resource tree through the links in the response payload on the individual

URIs. The following schemes are provided for the Service Root URI:

● OEM Scheme

● Redfish Scheme

OEM scheme

https://[IP or DNS name]/api

16 Key integration concepts