Machine Identity List REST Service

Use Machine Identity List REST Service to list known machine identities for a DS5000 device group.

Machine Identity List REST Service supports pagination. The following parameters are used for pagination: offset and count. The offset value specifies the page number from which the records are displayed. The count value specifies the number of records to display on a page, which you specify in the offset value. For example, to retrieve the first 10 records for the list, set offset = 1 and count = 10. To retrieve the next 10 records, set offset = 2 and count = 10. If you do not specify values for pagination parameters, the first 2000 records are returned.
Operation
GET
URL
To retrieve all machine identities:
https://<host>:<port>/SKLM/rest/v1/machines
Note: Returns the first 2000 records.
To retrieve a specific list with pagination:
https://<host>:<port>/SKLM/rest/v1/machines?offset=<offset>&count=<count>

By default, Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters
Parameter Description
host Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM Security 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 Security Guardium Key Lifecycle Manager. For example, en or de.
Query parameters
Parameter name Description
offset Optional. Specify the page number from which the records are displayed based on the value that you specify for count.
count Optional. Specify the number of records to display on the page that you specified with offset. The count must not exceed 2000 records.

Response

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
Machine ID Returns the unique machine identification.
Machine UUID Returns the universal unique identifier of the machine.
Machine Text Returns the machine text of the machine that helps you to uniquely identify the machine.
Device Group Returns the device group of the machine.
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 list the machine identities
GET https://localhost:<port>/SKLM/rest/v1/machines
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Success response
Status Code : 200 OK
[
   {
        “Machine ID”:”3042383030303437000000005110”,
				“Machine UUID” : “MACHINE-9efafff1-1df2-4cf9-abd4-fefee4d72508”,
				“Device group” : “DS5000”   
		},
   {
       “Machine ID”:”3042383030303437000000005111”,
				“Machine UUID” : “MACHINE-f33140c8-a2bc-4aa0-afd3-f94a6208dbf0”,
				“Machine Text” : “machineText001”,
				“Device group” : “DS5000”  
 		}
	]
Service request to list the machine identities when you specify incorrect parameter
GET https://localhost:<port>/SKLM/rest/v1/machines/COUNT=2&offset=1  
Content-Type: application/json  
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Error response
Status Code : 400 Bad Request
{"code":"CTGKM0630E","message":"CTGKM0630E Validation error: 
\"Invalid name \" for parameter \"Count\"."}