Use the Endpoint (Device Group) Base List REST Service to list all of
the endpoint families that IBM Guardium Key Lifecycle Manager provides,
such as LTO and 3592.
- Operation
GET- URL
- https://host:port/GKLM/rest/v1/deviceGroups/base
By default, IBM® Guardium Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM Guardium Key Lifecycle Manager installation, you can modify this
default port.
Request Parameters
| Parameter |
Description |
| host |
Specify the IP address or hostname of the IBM Guardium Key Lifecycle Manager server. |
| port |
Specify the port number on which the IBM Guardium Key Lifecycle Manager server listens for requests. |
Request Headers
| Header name |
Value |
| Content-Type |
application/json |
| Accept |
application/json |
| Authorization |
SKLMAuth userAuthId=<authIdValue> |
| Accept-Language |
Any valid locale that is supported by IBM Guardium Key Lifecycle Manager. For example, en or
de. |
Response Headers
| Header name |
Value and description |
| Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
| Content-Type |
application/json |
| Content-Language |
Locale for the response message. |
Success response body
JSON object with the following specification:
| JSON property name |
Description |
| Device Family |
Returns a list of base endpoint families that is supported by IBM Guardium Key Lifecycle Manager, such as LTO and
3592. |
Error Response Body
JSON object with the following specification.
| JSON property name |
Description |
| code |
Returns the application error code. |
| message |
Returns a message that describes the error. |
Examples
- Service request to get endpoint (device group) base list
GET https://localhost:<port>/GKLM/rest/v1/deviceGroups/base
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Success response
Status Code: 200 OK
[
{ "Device Family": "3592" },
{ "Device Family": "LTO" },
{ "Device Family": "DS8000" },
{ "Device Family": "DS5000" },
{ "Device Family": "GENERIC" },
{ "Device Family": "GPFS" },
{ "Device Family": "PEER_TO_PEER" }
]