List KMIP Objects

Request

Method

URI

GET

v5/kmipsrv_object/. This method includes the following query string parameters:

  • _limit=n, where n is the total number of objects to retrieve.
  • _offset=i, where i is the index of the first object you want to retrieve. To specify the first object in the list, use _offset=0.
  • attr—An optional parameter that returns details about each KMIP object. If you omit this parameter, the API only returns the UUID for each object in the list.

For example, the following call retrieves all details for the first 100 objects in the list starting at the top: /v5/kmipsrv_object/?_offset=0&_limit=100&attr=ATTR&

Privileges Required

SEC_ADMIN.

Parameters

None.

Response

Name

Type

Example

lastref

integer

0

The index of the newest KMIP object in the list. This value matches the specified offset query string parameter.

objcount

integer

 
20

The total number of objects in the list. This value matches the specified limit query string parameter.

total_objects

integer

100

The total number of objects stored in the KMIP server.

return

list

 
{ IDENT: [], 
    UUID: “1a680bd5-db9b-11e8-b14e-00505685f1d7”,
    DESC: null, 
    ATTRS: { State: ‘PreActive’, ObjectType: “PrivateKey”, 
             LastChangeDate: "2018-10-29T16:53:04+00:00”,
             InitialDate: "2018-10-29T16:53:04+00:00”}
           },..]

The example above shows the results for one of the KMIP objects in the list if the attr query string parameter is specified on the API call.

Errors

Reason

Example

KMIP Server is disabled

KMIP server not enabled.