Administrator Guide

Accessing the REST service

The base URL for a REST request is in the following format:

http://<host>:<port>/api/<Program_Space>/<version>

Table 30. Accessing the REST service

Parameter Description

Host The address of the host running the REST server. This address can be the Fully Qualified Domain Name

(FQDN) of the host or an IP address.

Port The port number opened for REST traffic. The default port is 8012.

Program_Space The application namespace: “SEM”.

Version The mainly supported version is 1.0 and later.

For example, the base URL http://127.0.0.1:8012/api/SEM/1.0/ is used to access the REST server locally.

NOTE:

For the remainder of this chapter, [base_url] is used in place of the base URL syntax.

To obtain information about different devices, you must use the following REST query:

[base_url]/<item_group>

To obtain information about a single device, you must use the following REST query:

[base_url]/<item_group>/<index | wwid>

The <item_group> variable represents the different types of devices contained within the storage enclosure. Following are the item_

group values (device types):

• adapters

• currentsensors

• drawers

• drives

1, 2

• driveslots

• enclosures

• emms

• emmslots

• fans

• locks

• powersupplies

• voltagesensors

NOTE:

EMM and drive item groups are queried at a higher level without having to reference an adapter or enclosure.

NOTE:

Adapters, enclosures, and drives are the only item groups that can provide more information about a single

device in the item group by specifying an index value or World Wide ID (WWID).

SHM REST Resources

Device Inventory

SHM REST resources include device inventory.

/api/SEM/1.0/adapters [GET]

/api/SEM/1.0/adapters{id} [GET]

Dell Storage enclosure REST API